|KCmdLineOptions (const KCmdLineOptions &options)|
|KCmdLineOptions &||add (const QByteArray &name, const KLocalizedString &description=KLocalizedString(), const QByteArray &defaultValue=QByteArray())|
|KCmdLineOptions &||add (const KCmdLineOptions &options)|
|KCmdLineOptions &||operator= (const KCmdLineOptions &options)|
Class that holds command line options.
This class is intended to be used with the KCmdLineArgs class, which provides convenient and powerful command line argument parsing and handling functionality.
- See also
- KCmdLineArgs for additional usage information
Constructor & Destructor Documentation
|KCmdLineOptions::KCmdLineOptions||(||const KCmdLineOptions &||options||)|
Member Function Documentation
|KCmdLineOptions & KCmdLineOptions::add||(||const QByteArray &||name,|
|const KLocalizedString &||description =
|const QByteArray &||defaultValue =
Add command line option, by providing its name, description, and possibly a default value.
These will print out when myapp –help is called on the command line.
Note that a long option can only have one short (single character) alias
- 4.6 Note that the following does not apply to options that begin with "no" and expect a parameter, like "nooption4" in the example below.
Note that if the option name begin with "no" that you will need to test for the name without the "no" and the result will be the inverse of what is specified. i.e. if "nofoo" is the name of the option and myapp –nofoo is called:
Here are some more examples showing various features:
name option name description option description, made available for translation; can be left off defaultValue default option value, when the value is not specified on the command line; can be left off
The documentation for this class was generated from the following files: