KXQTS::ProgramArgument< T > Class Template Reference

Represents a program argument, such as --help. More...

#include <ProgramArgument.h>

Collaboration diagram for KXQTS::ProgramArgument< T >:

[legend]List of all members.

Public Types
typedef QList< ProgramArgument< T > >	List
enum	OptionKind { Switch, Parameter }
Public Member Functions
QString	description () const
T	identifier () const
OptionKind	kind () const
QString	longName () const
qint16	maximumCount () const
qint16	minimumCount () const
	ProgramArgument (const T iD=T(), const QString &longOpt=QString(), const QChar shortOpt=QChar())
void	setDescription (const QString &desc)
void	setIdentifier (const T id)
void	setKind (const OptionKind k)
void	setLongName (const QString &name)
void	setMaximumCount (const qint16 optionCount)
void	setMinimumCount (const qint16 optionCount)
void	setShortName (const QString &name)
QChar	shortName () const

---

Detailed Description

template<typename T>
class KXQTS::ProgramArgument< T >

Represents a program argument, such as --help.

See also:

ProgramArguments

Author:

Frans Englich <frans.englich@telia.com>

Examples:

Example-ProgramArguments.cpp.

Definition at line 33 of file ProgramArgument.h.

---

Member Enumeration Documentation

template<typename T>

enum KXQTS::ProgramArgument::OptionKind

Enumerator:

Switch	An argument that is of type Switch can either on or off but have a value. For example: "--enable-warnings".
Parameter	An argument of type Parameter specifies a value. For example, "--include include/path/".

Definition at line 40 of file ProgramArgument.h.

---

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

• kxqts/lib/ProgramArgument.h

---