QCommandLineOption Class

Documentation des fonctions membres

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

Construit un objet option de ligne de commande avec le nom name.

Le nom peut être court ou long. Si le nom ne comporte qu'un seul caractère, il est considéré comme 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 = et ne peuvent pas être répétés.

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

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

Construit un objet d'option de ligne de commande avec les noms 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 d'une longueur d'un 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 = 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())

Construit un objet option de ligne de commande avec les arguments donnés.

Le nom de l'option est fixé à name. Le nom peut être court ou long. Si le nom ne comporte qu'un seul caractère, il est considéré comme 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 = et ne peuvent pas être répétés.

La description est fixée à description. Il est d'usage d'ajouter un "." à la fin de la description.

En outre, l'adresse valueName doit être définie si l'option attend une valeur. La valeur par défaut de l'option est defaultValue.

Dans les versions de Qt antérieures à 5.4, ce constructeur était explicit. Dans Qt 5.4 et les versions ultérieures, il ne l'est plus et peut être utilisé pour une initialisation uniforme :

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

Voir aussi setDescription(), setValueName(), et setDefaultValues().

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

Construit un objet d'option de ligne de commande avec les arguments donnés.

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

Les noms de l'option sont définis à names. Les noms peuvent être courts ou longs. Tout nom de la liste ayant une longueur d'un 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 = et ne peuvent pas être répétés.

La description est fixée à description. Il est d'usage d'ajouter un "." à la fin de la description.

En outre, l'adresse valueName doit être définie si l'option attend une valeur. La valeur par défaut de l'option est defaultValue.

Dans les versions de Qt antérieures à 5.4, ce constructeur était explicit. Dans Qt 5.4 et les versions ultérieures, il ne l'est plus et peut être utilisé pour une initialisation uniforme :

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

Voir aussi setDescription(), setValueName(), et setDefaultValues().

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

Construit un objet QCommandLineOption qui est une copie de l'objet QCommandLineOption other.

Voir aussi operator=().

[noexcept] QCommandLineOption::~QCommandLineOption()

Détruit l'objet option de la 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 de cette option.

Voir aussi setDescription().

QCommandLineOption::Flags QCommandLineOption::flags() const

Renvoie un ensemble de drapeaux qui affectent cette option de ligne de commande.

Voir aussi 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 à 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 à 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 à description.

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

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

Voir également description().

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

Définir l'ensemble des drapeaux qui affectent cette option de ligne de commande à flags.

Voir aussi flags() et QCommandLineOption::Flags.

void QCommandLineOption::setValueName(const QString &valueName)

Définit le nom de la valeur attendue, pour la documentation, à valueName.

Les options sans valeur assignée ont un comportement de type booléen : soit l'utilisateur spécifie -option, soit il ne le fait pas.

Les options avec une valeur assignée doivent définir un nom pour la valeur attendue, pour la documentation de l'option dans l'aide. Une option portant les noms o et output, et dont la valeur est file apparaîtra sous la forme -o, --output <file>.

Appelez QCommandLineParser::value() si vous pensez que l'option ne sera présente qu'une seule fois, et QCommandLineParser::values() si vous pensez que l'option sera présente plusieurs fois.

Voir également valueName().

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

Remplace cette option par other. Cette opération est très rapide et n'échoue jamais.

QString QCommandLineOption::valueName() const

Renvoie le nom de la valeur attendue.

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

Voir aussi setValueName().

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

Move-assigne other à cette instance QCommandLineOption.

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

Fait une copie de l'objet other et l'affecte à l'objet QCommandLineOption.