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 。

在 5.4 之前的 Qt 版本中，该构造函数是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 。

在 5.4 之前的 Qt 版本中，该构造函数是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)

Move-assignsother 到此QCommandLineOption 实例。

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

复制other 对象并将其赋值给QCommandLineOption 对象。