QCommandLineOption Class

Dokumentation zu den Mitgliedsfunktionen

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

Erstellt ein Objekt für eine Befehlszeilenoption mit dem Namen „ name “.

Der Name kann entweder kurz oder lang sein. Wenn der Name aus einem Zeichen besteht, gilt er als kurzer Name. Optionsnamen dürfen nicht leer sein, dürfen nicht mit einem Bindestrich oder einem Schrägstrich beginnen, dürfen kein „ = “ enthalten und dürfen nicht wiederholt werden.

Siehe auch „ setDescription()“, „ setValueName()“ und „ setDefaultValues()“.

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

Erstellt ein Objekt für eine Befehlszeilenoption mit den Namen „ names “.

Diese Überladung ermöglicht es, mehrere Namen für die Option festzulegen, zum Beispiel „ o “ und „ output “.

Die Namen können entweder kurz oder lang sein. Jeder Name in der Liste, der aus einem Zeichen besteht, ist ein kurzer Name. Optionsnamen dürfen nicht leer sein, nicht mit einem Bindestrich oder einem Schrägstrich beginnen, kein „ = “ enthalten und nicht wiederholt werden.

Siehe auch setDescription(), setValueName() und setDefaultValues().

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

Erstellt ein Objekt für eine Befehlszeilenoption mit den angegebenen Argumenten.

Der Name der Option wird auf „ name “ gesetzt. Der Name kann entweder kurz oder lang sein. Wenn der Name aus einem Zeichen besteht, gilt er als Kurzname. Optionsnamen dürfen nicht leer sein, dürfen nicht mit einem Bindestrich oder einem Schrägstrich beginnen, dürfen keine „ = “ enthalten und dürfen nicht wiederholt werden.

Die Beschreibung wird auf „ description “ gesetzt. Es ist üblich, am Ende der Beschreibung einen Punkt („.“) hinzuzufügen.

Außerdem muss der valueName festgelegt werden, wenn die Option einen Wert erwartet. Der Standardwert für die Option ist auf defaultValue gesetzt.

In Qt-Versionen vor 5.4 lautete dieser Konstruktor „ explicit “. In Qt 5.4 und höher ist dies nicht mehr der Fall, und er kann zur einheitlichen Initialisierung verwendet werden:

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

Siehe auch „ setDescription()“, „ setValueName()“ und „ setDefaultValues()“.

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

Erstellt ein Objekt für eine Befehlszeilenoption mit den angegebenen Argumenten.

Diese Überladung ermöglicht es, mehrere Namen für die Option festzulegen, zum Beispiel „ o “ und „ output “.

Die Namen der Option werden auf „ names “ gesetzt. Die Namen können entweder kurz oder lang sein. Jeder Name in der Liste, der aus einem Zeichen besteht, ist ein Kurzname. Optionsnamen dürfen nicht leer sein, dürfen nicht mit einem Bindestrich oder einem Schrägstrich beginnen, dürfen kein „ = “ enthalten und dürfen nicht wiederholt werden.

Die Beschreibung ist auf „ description “ festgelegt. Es ist üblich, am Ende der Beschreibung einen „.“ hinzuzufügen.

Außerdem muss der valueName festgelegt werden, wenn die Option einen Wert erwartet. Der Standardwert für die Option ist auf defaultValue gesetzt.

In Qt-Versionen vor 5.4 lautete dieser Konstruktor „ explicit “. In Qt 5.4 und höher ist dies nicht mehr der Fall, und er kann zur einheitlichen Initialisierung verwendet werden:

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

Siehe auch „ setDescription()“, „ setValueName()“ und „ setDefaultValues()“.

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

Erstellt ein QCommandLineOption-Objekt, das eine Kopie des QCommandLineOption-Objekts other ist.

Siehe auch operator=().

[noexcept] QCommandLineOption::~QCommandLineOption()

Löscht das Objekt der Befehlszeilenoption.

QStringList QCommandLineOption::defaultValues() const

Gibt die für diese Option festgelegten Standardwerte zurück.

Siehe auch „ setDefaultValues()“.

QString QCommandLineOption::description() const

Gibt die für diese Option festgelegte Beschreibung zurück.

Siehe auch ` setDescription()`.

QCommandLineOption::Flags QCommandLineOption::flags() const

Gibt eine Reihe von Flags zurück, die sich auf diese Befehlszeilenoption auswirken.

Siehe auch setFlags() und QCommandLineOption::Flags.

QStringList QCommandLineOption::names() const

Gibt die für diese Option festgelegten Namen zurück.

void QCommandLineOption::setDefaultValue(const QString &defaultValue)

Legt den Standardwert für diese Option auf „ defaultValue “ fest.

Der Standardwert wird verwendet, wenn der Benutzer der Anwendung die Option nicht über die Befehlszeile angibt.

Ist ` defaultValue ` leer, hat die Option keine Standardwerte.

Siehe auch „ defaultValues()“ und „ setDefaultValues()“.

void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)

Legt die Liste der für diese Option verwendeten Standardwerte auf „ defaultValues “ fest.

Die Standardwerte werden verwendet, wenn der Benutzer der Anwendung die Option nicht über die Befehlszeile angibt.

Siehe auch „ defaultValues()“ und „ setDefaultValue()“.

void QCommandLineOption::setDescription(const QString &description)

Legt die Beschreibung für diese Option auf „ description “ fest.

Es ist üblich, am Ende der Beschreibung einen „.“ hinzuzufügen.

Die Beschreibung wird von ` QCommandLineParser::showHelp()` verwendet.

Siehe auch description().

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

Setzen Sie die Flags, die diese Befehlszeilenoption beeinflussen, auf „ flags “.

Siehe auch „ flags()“ und „ QCommandLineOption::Flags “.

void QCommandLineOption::setValueName(const QString &valueName)

Legt den Namen des erwarteten Werts für die Dokumentation auf „ valueName “ fest.

Optionen, denen kein Wert zugewiesen wurde, verhalten sich wie boolesche Werte: Entweder gibt der Benutzer die Option an – oder nicht.

Optionen, denen ein Wert zugewiesen wurde, müssen einen Namen für den erwarteten Wert festlegen, damit dieser in der Dokumentation der Option in der Hilfe-Ausgabe erscheint. Eine Option mit den Namen „ o “ und „ output “ sowie dem Wertnamen „ file “ wird als „ -o, --output <file> “ angezeigt.

Rufen Sie „ QCommandLineParser::value()“ auf, wenn Sie davon ausgehen, dass die Option nur einmal vorhanden ist, und „ QCommandLineParser::values()“, wenn Sie davon ausgehen, dass diese Option mehrfach vorhanden ist.

Siehe auch ` valueName()`.

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

Tauscht diese Option mit „ other “ aus. Dieser Vorgang ist sehr schnell und schlägt niemals fehl.

QString QCommandLineOption::valueName() const

Gibt den Namen des erwarteten Werts zurück.

Ist das Feld leer, nimmt die Option keinen Wert an.

Siehe auch ` setValueName()`.

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

Weist „ other “ dieser „ QCommandLineOption “-Instanz zu.

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

Erstellt eine Kopie des Objekts „ other “ und weist sie diesem Objekt „ QCommandLineOption “ zu.