Help Class Reference

Help container class. More...

#include <help.h>

Inheritance diagram for Help:

Public Member Functions
	Help (void)
	Default constructor. More...
	Help (const Help &CLI_Help)
	Copy constructor. More...
virtual	~Help (void)
	Destructor. More...
Help &	operator= (const Help &CLI_Help)
	Assignment operator. More...
Help &	AddHelp (const LANG E_Lang, const char *const STR_Help)
	Help extension. More...
Public Member Functions inherited from ResourceString
	ResourceString (void)
	Default constructor. More...
	ResourceString (const ResourceString &CLI_String)
	Copy constructor. More...
virtual	~ResourceString (void)
	Destructor. More...
ResourceString &	operator= (const ResourceString &STR_String)
	Assignment operator. More...
ResourceString &	Reset (void)
	Resets the resource string. More...
ResourceString &	SetString (const LANG E_Lang, const char *const STR_String)
	Adds resource for a given language. More...
const bool	HasString (const LANG E_Lang) const
	Determines whether a string exists for a given language. More...
const tk::String	GetString (const LANG E_Lang) const
	Access to the string of a given language. More...
const bool	IsEmpty (void) const
	Determines whether the resource string is empty (ie no string has been set for any language). More...
Public Member Functions inherited from Object
virtual	~Object (void)=0
	Pure virtual destructor. More...

Additional Inherited Members
Public Types inherited from ResourceString
enum	LANG { LANG_EN, LANG_FR, LANG_COUNT, LANG_DEFAULT = LANG_EN }
	Languages identifiers. More...
Static Public Member Functions inherited from ResourceString
static const tk::String	Concat (const char *const STR_1, const char *const STR_2)
	String concatenation in the aim of a resource definition. More...
static const tk::String	Concat (const char *const STR_1, const char *const STR_2, const char *const STR_3)
	String concatenation in the aim of a resource definition. More...
static const tk::String	Concat (const char *const STR_1, const char *const STR_2, const char *const STR_3, const char *const STR_4)
	String concatenation in the aim of a resource definition. More...
static const tk::String	Concat (const char *const STR_1, const char *const STR_2, const char *const STR_3, const char *const STR_4, const char *const STR_5)
	String concatenation in the aim of a resource definition. More...
Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Detailed Description

Help container class.

Objects of this class permits help definition of different languages. An object of this class is owned by each CLI element.

Definition at line 46 of file help.h.

Constructor & Destructor Documentation

Help() [1/2]

Help::Help ( void  )

explicit

Default constructor.

Help() [2/2]

Help::Help

(

const Help &

CLI_Help

)

Copy constructor.

Parameters

CLI_Help

Source help object.

~Help()

virtual Help::~Help ( void  )

virtual

Destructor.

Member Function Documentation

AddHelp()

Help& Help::AddHelp	(	const LANG	E_Lang,
		const char *const	STR_Help
	)

Help extension.

Returns

Same Help instance reference.

Parameters

E_Lang	Language.
STR_Help	Help message.

operator=()

Help& Help::operator=

(

const Help &

CLI_Help

)

Assignment operator.

Returns

Same Help instance reference.

Parameters

CLI_Help

Source help object.

---

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

• help.h