Search for usage in LXR

KCmdLineOptions Class Reference

#include <kcmdlineargs.h>

Public Member Functions

 KCmdLineOptions ()
 KCmdLineOptions (const KCmdLineOptions &options)
 ~KCmdLineOptions ()
KCmdLineOptionsadd (const KCmdLineOptions &options)
KCmdLineOptionsadd (const QByteArray &name, const KLocalizedString &description=KLocalizedString(), const QByteArray &defaultValue=QByteArray())
KCmdLineOptionsoperator= (const KCmdLineOptions &options)

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
since 5.0, port to QCommandLineParser in QtCore

Definition at line 53 of file kcmdlineargs.h.

Constructor & Destructor Documentation

◆ KCmdLineOptions() [1/2]

KCmdLineOptions::KCmdLineOptions ( )


Definition at line 116 of file kcmdlineargs.cpp.

◆ KCmdLineOptions() [2/2]

KCmdLineOptions::KCmdLineOptions ( const KCmdLineOptions options)

Copy constructor.

Definition at line 125 of file kcmdlineargs.cpp.

◆ ~KCmdLineOptions()

KCmdLineOptions::~KCmdLineOptions ( )


Definition at line 120 of file kcmdlineargs.cpp.

Member Function Documentation

◆ add() [1/2]

KCmdLineOptions & KCmdLineOptions::add ( const KCmdLineOptions options)

Add all options from another KCmdLineOptions object.

optionsoptions to add

Definition at line 148 of file kcmdlineargs.cpp.

◆ add() [2/2]

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 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:

KCmdLineArgs::parsedArgs()->isSet("foo"); // false

Here are some more examples showing various features:

options.add("a", ki18n("A short binary option"));
options.add("b <file>", ki18n("A short option which takes an argument"));
options.add("c <speed>", ki18n("As above but with a default value"), "9600");
options.add("option1", ki18n("A long binary option, off by default"));
options.add("nooption2", ki18n("A long binary option, on by default"));
options.add(":", ki18n("Extra options:"));
options.add("option3 <file>", ki18n("A long option which takes an argument"));
options.add("nooption4 <speed>", ki18n("A long option which takes an argument, defaulting to 9600"), "9600");
options.add("d").add("option5", ki18n("A long option which has a short option as alias"));
options.add("e").add("nooption6", ki18n("Another long option with an alias"));
options.add("f").add("option7 <speed>", ki18n("'--option7 speed' is the same as '-f speed'"));
options.add("!option8 <cmd>", ki18n("All options following this one will be treated as arguments"));
options.add("+file", ki18n("A required argument 'file'"));
options.add("+[arg1]", ki18n("An optional argument 'arg1'"));
options.add("!+command", ki18n("A required argument 'command', that can contain multiple words, even starting with '-'"));
options.add("", ki18n("Additional help text not associated with any particular option"));
nameoption name
descriptionoption description, made available for translation; can be left off
defaultValuedefault option value, when the value is not specified on the command line; can be left off

Definition at line 138 of file kcmdlineargs.cpp.

◆ operator=()

KCmdLineOptions & KCmdLineOptions::operator= ( const KCmdLineOptions options)

Assignment operator.

Definition at line 130 of file kcmdlineargs.cpp.

The documentation for this class was generated from the following files:
static KCmdLineArgs * parsedArgs(const QByteArray &id=QByteArray())
Access parsed arguments.
bool isSet(const QByteArray &option) const
Read out a boolean option or check for the presence of string option.
KLocalizedString KI18N_EXPORT ki18n(const char *text)
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.
Class that holds command line options.
Definition: kcmdlineargs.h:53
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Sep 30 2023 03:56:38 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.