#include <tdecmdlineargs.h>

Public Attributes
const char *	name

const char *	description

const char *	def

Detailed Description

Structure that holds command line options.

This class is intended to be used with the TDECmdLineArgs class, which provides convenient and powerful command line argument parsing and handling functionality.

See also: TDECmdLineArgs for additional usage information

Definition at line 40 of file tdecmdlineargs.h.

Member Data Documentation

◆ def

const char* TDECmdLineOptions::def

The default value for the option, if it is not specified on the command line.

Definition at line 65 of file tdecmdlineargs.h.

◆ description

const char* TDECmdLineOptions::description

The text description of the option as should appear in myapp –help.

This value should be wrapped with I18N_NOOP().

Definition at line 60 of file tdecmdlineargs.h.

◆ name

const char* TDECmdLineOptions::name

The name of the argument as it should be called on the command line and appear in myapp –help.

Note that if this option starts 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:

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

TDECmdLineArgs::isSet

bool isSet(const char *option) const

Read out a boolean option or check for the presence of string option.

Definition: tdecmdlineargs.cpp:1181

TDECmdLineArgs::parsedArgs

static TDECmdLineArgs * parsedArgs(const char *id=0)

Access parsed arguments.

Definition: tdecmdlineargs.cpp:310

Definition at line 55 of file tdecmdlineargs.h.

The documentation for this struct was generated from the following file: