The QCommandLineOption class defines a possible command-line option. 更多...
| 头： | #include <QCommandLineOption> |
| qmake: | QT += core |
| Since: | Qt 5.2 |
| enum | Flag { HiddenFromHelp, ShortOptionStyle } |
| flags | Flags |
| QCommandLineOption (const QString & name ) | |
| QCommandLineOption (const QStringList & 名称 ) | |
| QCommandLineOption (const QString & name , const QString & description , const QString & valueName = QString(), const QString & defaultValue = QString()) | |
| QCommandLineOption (const QStringList & 名称 , const QString & description , const QString & valueName = QString(), const QString & defaultValue = QString()) | |
| QCommandLineOption (const QCommandLineOption & other ) | |
| ~QCommandLineOption () | |
| QStringList | defaultValues () const |
| QString | description () const |
| Flags | flags () const |
| QStringList | 名称 () const |
| void | setDefaultValue (const QString & defaultValue ) |
| void | setDefaultValues (const QStringList & defaultValues ) |
| void | setDescription (const QString & description ) |
| void | setFlags (Flags flags ) |
| void | setValueName (const QString & valueName ) |
| void | swap (QCommandLineOption & other ) |
| QString | valueName () const |
| QCommandLineOption & | operator= (const QCommandLineOption & other ) |
| QCommandLineOption & | operator= (QCommandLineOption && other ) |
The QCommandLineOption class defines a possible command-line option.
This class is used to describe an option on the command line. It allows different ways of defining the same option with multiple aliases possible. It is also used to describe how the option is used - it may be a flag (e.g.
-v
) or take a value (e.g.
-o file
).
范例：
QCommandLineOption verboseOption("verbose", "Verbose mode. Prints out more information."); QCommandLineOption outputOption(QStringList() << "o" << "output", "Write generated data into <file>.", "file");
另请参阅 QCommandLineParser .
| 常量 | 值 | 描述 |
|---|---|---|
QCommandLineOption::HiddenFromHelp
|
0x1
|
Hide this option in the user-visible help output. All options are visible by default. Setting this flag for a particular option makes it internal, i.e. not listed in the help output. |
QCommandLineOption::ShortOptionStyle
|
0x2
|
The option will always be understood as a short option, regardless of what was set by
QCommandLineParser::setSingleDashWordOptionMode
. This allows flags such as
-DDEFINE=VALUE
or
-I/include/path
to be interpreted as short flags even when the parser is in
QCommandLineParser::ParseAsLongOptions
模式。
|
Flags 类型是 typedef 对于 QFlags <Flag>。它存储 Flag 值的 OR 组合。
另请参阅 QCommandLineOption::setFlags () 和 QCommandLineOption::flags ().
Constructs a command line option object with the name name .
The name can be either short or long. If the name is one character in length, it is considered a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a
=
and cannot be repeated.
另请参阅 setDescription (), setValueName ()，和 setDefaultValues ().
Constructs a command line option object with the names 名称 .
This overload allows to set multiple names for the option, for instance
o
and
output
.
The names can be either short or long. Any name in the list that is one character in length is a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a
=
and cannot be repeated.
另请参阅 setDescription (), setValueName ()，和 setDefaultValues ().
Constructs a command line option object with the given arguments.
The name of the option is set to
name
. The name can be either short or long. If the name is one character in length, it is considered a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a
=
and cannot be repeated.
描述被设为 description . It is customary to add a "." at the end of the description.
此外， valueName needs to be set if the option expects a value. The default value for the option is set to defaultValue .
In Qt versions before 5.4, this constructor was
explicit
. In Qt 5.4 and later, it no longer is and can be used for C++11-style uniform initialization:
QCommandLineParser parser; parser.addOption({"verbose", "Verbose mode. Prints out more information."});
另请参阅 setDescription (), setValueName ()，和 setDefaultValues ().
Constructs a command line option object with the given arguments.
This overload allows to set multiple names for the option, for instance
o
and
output
.
The names of the option are set to
名称
. The names can be either short or long. Any name in the list that is one character in length is a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a
=
and cannot be repeated.
描述被设为 description . It is customary to add a "." at the end of the description.
此外， valueName needs to be set if the option expects a value. The default value for the option is set to defaultValue .
In Qt versions before 5.4, this constructor was
explicit
. In Qt 5.4 and later, it no longer is and can be used for C++11-style uniform initialization:
QCommandLineParser parser; parser.addOption({{"o", "output"}, "Write generated data into <file>.", "file"});
另请参阅 setDescription (), setValueName ()，和 setDefaultValues ().
构造 QCommandLineOption object that is a copy of the QCommandLineOption 对象 other .
另请参阅 operator= ().
销毁命令行选项对象。
返回此选项的默认值设置。
另请参阅 setDefaultValues ().
返回此选项的描述设置。
另请参阅 setDescription ().
Returns a set of flags that affect this command-line option.
该函数在 Qt 5.8 引入。
另请参阅 setFlags () 和 QCommandLineOption::Flags .
Returns the names set for this option.
Sets the default value used for this option to defaultValue .
The default value is used if the user of the application does not specify the option on the command line.
若 defaultValue is empty, the option has no default values.
另请参阅 defaultValues () 和 setDefaultValues ().
Sets the list of default values used for this option to defaultValues .
The default values are used if the user of the application does not specify the option on the command line.
另请参阅 defaultValues () 和 setDefaultValue ().
Sets the description used for this option to description .
It is customary to add a "." at the end of the description.
The description is used by QCommandLineParser::showHelp ().
另请参阅 description ().
Set the set of flags that affect this command-line option to flags .
该函数在 Qt 5.8 引入。
另请参阅 flags () 和 QCommandLineOption::Flags .
Sets the name of the expected value, for the documentation, to valueName .
Options without a value assigned have a boolean-like behavior: either the user specifies --option or they don't.
Options with a value assigned need to set a name for the expected value, for the documentation of the option in the help output. An option with names
o
and
output
, and a value name of
file
will appear as
-o, --output <file>
.
调用 QCommandLineParser::value () if you expect the option to be present only once, and QCommandLineParser::values () if you expect that option to be present multiple times.
另请参阅 valueName ().
Swaps option other with this option. This operation is very fast and never fails.
返回期望值的名称。
若为空，选项不带值。
另请参阅 setValueName ().
Makes a copy of the other object and assigns it to this QCommandLineOption 对象。
移动赋值 other 到此 QCommandLineOption 实例。
该函数在 Qt 5.2 引入。
