KDECore
KCmdLineOptions Class Reference
Class that holds command line options. More...
#include <kcmdlineargs.h>
Public Member Functions | |
KCmdLineOptions & | add (const KCmdLineOptions &options) |
KCmdLineOptions & | add (const QByteArray &name, const KLocalizedString &description=KLocalizedString(), const QByteArray &defaultValue=QByteArray()) |
KCmdLineOptions (const KCmdLineOptions &options) | |
KCmdLineOptions () | |
KCmdLineOptions & | operator= (const KCmdLineOptions &options) |
~KCmdLineOptions () |
Detailed Description
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
Definition at line 48 of file kcmdlineargs.h.
Constructor & Destructor Documentation
KCmdLineOptions::KCmdLineOptions | ( | ) |
Constructor.
Definition at line 123 of file kcmdlineargs.cpp.
KCmdLineOptions::KCmdLineOptions | ( | const KCmdLineOptions & | options | ) |
Copy constructor.
Definition at line 132 of file kcmdlineargs.cpp.
KCmdLineOptions::~KCmdLineOptions | ( | ) |
Destructor.
Definition at line 127 of file kcmdlineargs.cpp.
Member Function Documentation
KCmdLineOptions & KCmdLineOptions::add | ( | const KCmdLineOptions & | options | ) |
Add all options from another KCmdLineOptions object.
- Parameters:
-
options options to add
Definition at line 155 of file kcmdlineargs.cpp.
KCmdLineOptions & KCmdLineOptions::add | ( | const QByteArray & | name, | |
const KLocalizedString & | description = KLocalizedString() , |
|||
const QByteArray & | defaultValue = QByteArray() | |||
) |
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 if the option name begins 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:
KCmdLineArgs::parsedArgs()->isSet("foo"); // false
- Parameters:
-
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
Definition at line 145 of file kcmdlineargs.cpp.
KCmdLineOptions & KCmdLineOptions::operator= | ( | const KCmdLineOptions & | options | ) |
Assignment operator.
Definition at line 137 of file kcmdlineargs.cpp.
The documentation for this class was generated from the following files: