QCommandLineOption Class

成员函数文档

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

构建一个名称为name 的命令行选项对象。

名称可以是短名称，也可以是长名称。如果名称长度为一个字符，则被视为短名称。选项名称不能为空，不能以连字符或斜杠开头，不能包含= ，且不能重复。

另请参阅 setDescription()、setValueName() 和setDefaultValues()。

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

构建一个名称为names 的命令行选项对象。

此重载允许为选项设置多个名称，例如o 和output 。

名称可以是短名称，也可以是长名称。列表中长度为一个字符的名称即为短名称。选项名称不能为空，不能以连字符或斜杠开头，不能包含= ，且不能重复。

另请参阅 setDescription()、setValueName() 和setDefaultValues()。

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

根据给定的参数构建一个命令行选项对象。

选项名称设置为name 。名称可以是短名称，也可以是长名称。如果名称长度为一个字符，则被视为短名称。选项名称不能为空，不能以连字符或斜杠开头，不能包含= ，且不能重复。

描述字段被设置为description 。通常会在描述末尾添加一个“.”。

此外，如果选项需要指定值，则需设置valueName 。该选项的默认值设为defaultValue 。

在 Qt 5.4 之前的版本中，该构造函数为explicit 。在 Qt 5.4 及后续版本中，情况已发生变化，该构造函数可用于统一初始化：

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

另请参阅 setDescription()、setValueName() 和setDefaultValues()。

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

根据给定的参数构建一个命令行选项对象。

此重载允许为选项设置多个名称，例如o 和output 。

选项的名称被设置为names 。名称可以是短名称，也可以是长名称。列表中长度为一个字符的名称即为短名称。选项名称不能为空，不能以连字符或斜杠开头，不能包含= ，且不能重复。

描述字段的值应设置为description 。通常会在描述末尾添加一个“.”。

此外，如果选项需要指定值，则需设置valueName 。该选项的默认值设置为defaultValue 。

在 Qt 5.4 之前的版本中，该构造函数为explicit 。在 Qt 5.4 及后续版本中，情况已发生变化，该构造函数可用于统一初始化：

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

另请参阅 setDescription()、setValueName() 和setDefaultValues()。

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

创建一个 QCommandLineOption 对象，该对象是 QCommandLineOption 对象other 的副本。

另请参阅 operator=()。

[noexcept] QCommandLineOption::~QCommandLineOption()

销毁该命令行选项对象。

QStringList QCommandLineOption::defaultValues() const

返回为该选项设置的默认值。

另请参阅 setDefaultValues()。

QString QCommandLineOption::description() const

返回为此选项设置的描述。

另请参阅 setDescription()。

QCommandLineOption::Flags QCommandLineOption::flags() const

返回一组影响此命令行选项的标志。

另请参阅 setFlags() 和QCommandLineOption::Flags 。

QStringList QCommandLineOption::names() const

返回为该选项设置的名称。

void QCommandLineOption::setDefaultValue(const QString &defaultValue)

将此选项的默认值设置为defaultValue 。

如果应用程序的用户未在命令行中指定该选项，则使用默认值。

如果defaultValue 为空，则该选项没有默认值。

另请参阅 defaultValues() 和setDefaultValues()。

void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)

将此选项使用的默认值列表设置为defaultValues 。

如果应用程序的用户未在命令行中指定该选项，则使用默认值。

另请参阅 defaultValues() 和setDefaultValue()。

void QCommandLineOption::setDescription(const QString &description)

将此选项的描述设置为description 。

通常会在描述末尾添加一个“.”。

该描述由QCommandLineParser::showHelp() 函数使用。

另请参阅 description()。

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

将影响此命令行选项的标志集设置为flags 。

另请参阅 flags() 和QCommandLineOption::Flags 。

void QCommandLineOption::setValueName(const QString &valueName)

将预期值的名称（用于文档）设置为valueName 。

未分配值的选项具有布尔类型的行为：用户要么指定了 –option，要么未指定。

已分配值的选项需要为预期值设置名称，以便在帮助输出中记录该选项的文档。一个名称分别为o 和output 、值名为file 的选项，将显示为-o, --output <file> 。

若预期该选项仅出现一次，请调用QCommandLineParser::value()；若预期该选项出现多次，请调用QCommandLineParser::values()。

另请参阅 valueName()。

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

将此选项与other 互换。此操作速度极快，且绝不会失败。

QString QCommandLineOption::valueName() const

返回预期值的名称。

如果为空，则该选项不接受任何值。

另请参阅 setValueName()。

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

将other 通过Move操作赋值给此QCommandLineOption 实例。

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

复制other 对象，并将副本赋值给此QCommandLineOption 对象。