QCommandLineOption Class

Documentation des fonctions membres

[explicit] QCommandLineOption::QCommandLineOption(const QString &name)

Crée un objet d'option de ligne de commande nommé « name ».

Le nom peut être court ou long. Si le nom ne comporte qu'un seul caractère, il est considéré comme un nom court. Les noms d'options ne doivent pas être vides, ne doivent pas commencer par un tiret ou une barre oblique, ne doivent pas contenir de « = » et ne peuvent pas être répétés.

Voir également setDescription(), setValueName() et setDefaultValues().

[explicit] QCommandLineOption::QCommandLineOption(const QStringList &names)

Crée un objet d'options de ligne de commande portant les noms suivants : names.

Cette surcharge permet de définir plusieurs noms pour l'option, par exemple o et output.

Les noms peuvent être courts ou longs. Tout nom de la liste comportant un seul caractère est considéré comme un nom court. Les noms d'options ne doivent pas être vides, ne doivent pas commencer par un tiret ou une barre oblique, ne doivent pas contenir de « = » et ne peuvent pas être répétés.

Voir également setDescription(), setValueName() et setDefaultValues().

QCommandLineOption::QCommandLineOption(const QString &name, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

Crée un objet d'option de ligne de commande avec les arguments fournis.

Le nom de l'option est défini sur name. Le nom peut être court ou long. Si le nom ne comporte qu'un seul caractère, il est considéré comme un nom court. Les noms d'options ne doivent pas être vides, ne doivent pas commencer par un tiret ou une barre oblique, ne doivent pas contenir d'= s et ne peuvent pas être répétés.

La description est définie sur description. Il est d’usage d’ajouter un « . » à la fin de la description.

De plus, la valueName doit être définie si l’option attend une valeur. La valeur par défaut de l’option est définie sur defaultValue.

Dans les versions de Qt antérieures à la version 5.4, ce constructeur était explicit. À partir de Qt 5.4, ce n’est plus le cas et il peut être utilisé pour une initialisation uniforme :

QCommandLineParser parser;
parser.addOption({"verbose", "Verbose mode. Prints out more information."});

Voir également setDescription(), setValueName() et setDefaultValues().

QCommandLineOption::QCommandLineOption(const QStringList &names, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

Crée un objet d'option de ligne de commande avec les arguments fournis.

Cette surcharge permet de définir plusieurs noms pour l'option, par exemple o et output.

Les noms de l'option sont définis sur names. Les noms peuvent être courts ou longs. Tout nom de la liste comportant un seul caractère est un nom court. Les noms d'options ne doivent pas être vides, ne doivent pas commencer par un tiret ou une barre oblique, ne doivent pas contenir de = et ne peuvent pas être répétés.

La description est définie comme suit : description. Il est d'usage d'ajouter un « . » à la fin de la description.

De plus, la valueName doit être définie si l’option attend une valeur. La valeur par défaut de l’option est définie sur defaultValue.

Dans les versions de Qt antérieures à la version 5.4, ce constructeur était explicit. À partir de Qt 5.4, ce n’est plus le cas et il peut être utilisé pour une initialisation uniforme :

QCommandLineParser parser;
parser.addOption({{"o", "output"}, "Write generated data into <file>.", "file"});

Voir également setDescription(), setValueName() et setDefaultValues().

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

Crée un objet `QCommandLineOption` qui est une copie de l'objet `QCommandLineOption` other.

Voir aussi operator=().

[noexcept] QCommandLineOption::~QCommandLineOption()

Supprime l'objet d'option de ligne de commande.

QStringList QCommandLineOption::defaultValues() const

Renvoie les valeurs par défaut définies pour cette option.

Voir aussi setDefaultValues().

QString QCommandLineOption::description() const

Renvoie la description associée à cette option.

Voir aussi setDescription().

QCommandLineOption::Flags QCommandLineOption::flags() const

Renvoie un ensemble d'indicateurs qui affectent cette option de ligne de commande.

Voir également setFlags() et QCommandLineOption::Flags.

QStringList QCommandLineOption::names() const

Renvoie les noms définis pour cette option.

void QCommandLineOption::setDefaultValue(const QString &defaultValue)

Définit la valeur par défaut de cette option sur « defaultValue ».

La valeur par défaut est utilisée si l'utilisateur de l'application ne spécifie pas l'option sur la ligne de commande.

Si defaultValue est vide, l'option n'a pas de valeur par défaut.

Voir également ` defaultValues()` et ` setDefaultValues()`.

void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)

Définit la liste des valeurs par défaut utilisées pour cette option sur « defaultValues ».

Les valeurs par défaut sont utilisées si l'utilisateur de l'application ne spécifie pas l'option sur la ligne de commande.

Voir également defaultValues() et setDefaultValue().

void QCommandLineOption::setDescription(const QString &description)

Définit la description utilisée pour cette option sur « description ».

Il est d'usage d'ajouter un « . » à la fin de la description.

La description est utilisée par la fonction QCommandLineParser::showHelp().

Voir également description().

void QCommandLineOption::setFlags(QCommandLineOption::Flags flags)

Définissez l'ensemble des indicateurs qui affectent cette option de ligne de commande sur flags.

Voir également flags() et QCommandLineOption::Flags.

void QCommandLineOption::setValueName(const QString &valueName)

Définit le nom de la valeur attendue, à des fins de documentation, sur « valueName ».

Les options auxquelles aucune valeur n’est attribuée se comportent comme des booléens : soit l’utilisateur spécifie –option, soit il ne le fait pas.

Les options auxquelles une valeur est attribuée doivent définir un nom pour la valeur attendue, à des fins de documentation de l’option dans l’aide. Une option portant les noms « o » et « output », et dont le nom de valeur est « file », apparaîtra sous la forme « -o, --output <file> ».

Appelez ` QCommandLineParser::value()` si vous vous attendez à ce que l’option ne soit présente qu’une seule fois, et ` QCommandLineParser::values()` si vous vous attendez à ce qu’elle soit présente plusieurs fois.

Voir également valueName().

[noexcept] void QCommandLineOption::swap(QCommandLineOption &other)

Permet d'inverser cette option avec « other ». Cette opération est très rapide et ne rencontre jamais d'échec.

QString QCommandLineOption::valueName() const

Renvoie le nom de la valeur attendue.

Si ce champ est vide, l'option ne prend pas de valeur.

Voir aussi setValueName().

[noexcept] QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)

Cette opération attribue l'other à cette instance QCommandLineOption.

QCommandLineOption &QCommandLineOption::operator=(const QCommandLineOption &other)

Crée une copie de l'objet « other » et l'attribue à cet objet « QCommandLineOption ».