Events_InfoMessage Class Reference

An event message for sending a string message which has to be translated. More...

Inheritance diagram for Events_InfoMessage:

Public Member Functions
	Events_InfoMessage (const void *theSender=0)
	Constructor. More...
	Events_InfoMessage (const std::string &theContext, const std::string &theMsg, const void *theSender=0)
	Constructor. More...
virtual	~Events_InfoMessage ()
	default destructor More...
void	setContext (const std::string &theContext)
	Set a context string. More...
std::string	context () const
	Returns context string. More...
void	setMessageString (const std::string &theMsg)
	Set message string for translation. More...
std::string	messageString () const
	Returns message. More...
Events_InfoMessage &	operator= (const std::string &theMsg)
bool	empty () const
void	addParameter (const std::string &theParam)
	Add parameter for message string of string type. More...
EVENTS_EXPORT void	addParameter (double theParam)
	Add parameter for message string of double type. More...
EVENTS_EXPORT void	addParameter (int theParam)
	Add parameter for message string of integer type. More...
std::list< std::string >	parameters () const
	Returns list of parameters. More...
EVENTS_EXPORT Events_InfoMessage &	arg (const std::wstring &theParam)
	Add parameter for message string of wstring type. More...
Events_InfoMessage &	arg (const std::string &theParam)
	Add parameter for message string of string type. More...
Events_InfoMessage &	arg (int theParam)
	Add parameter for message string of integer type. More...
Events_InfoMessage &	arg (double theParam)
	Add parameter for message string of double type. More...
EVENTS_EXPORT void	send ()
	Send the message. More...
const Events_ID &	eventID () const
	Returns identifier of the message. More...
void *	sender () const
	Returns sender of the message or NULL if it is anonymous message. More...

Static Public Member Functions
static Events_ID	errorID ()
	Identifier of this event (one for all errors) More...

Detailed Description

An event message for sending a string message which has to be translated.

Constructor & Destructor Documentation

Events_InfoMessage() [1/2]

Events_InfoMessage::Events_InfoMessage ( const void *  theSender = 0 )

inlineexplicit

Constructor.

Parameters

theSender

a pointer on sender object

Events_InfoMessage() [2/2]

Events_InfoMessage::Events_InfoMessage ( const std::string &  theContext, const std::string &  theMsg, const void *  theSender = 0  )

inline

Constructor.

Parameters

theSender

a pointer on sender object

~Events_InfoMessage()

virtual Events_InfoMessage::~Events_InfoMessage ( )

inlinevirtual

default destructor

Member Function Documentation

errorID()

static Events_ID Events_InfoMessage::errorID ( )

inlinestatic

Identifier of this event (one for all errors)

setContext()

void Events_InfoMessage::setContext ( const std::string &  theContext )

inline

Set a context string.

Parameters

theContext

a context string

context()

std::string Events_InfoMessage::context ( ) const

inline

Returns context string.

setMessageString()

void Events_InfoMessage::setMessageString ( const std::string &  theMsg )

inline

Set message string for translation.

Parameters

theMsg

the string of message

messageString()

std::string Events_InfoMessage::messageString ( ) const

inline

Returns message.

addParameter() [1/3]

void Events_InfoMessage::addParameter ( const std::string &  theParam )

inline

Add parameter for message string of string type.

Parameters

theParam

the parameter

addParameter() [2/3]

void Events_InfoMessage::addParameter

(

double

theParam

)

Add parameter for message string of double type.

Parameters

theParam

the parameter

addParameter() [3/3]

void Events_InfoMessage::addParameter

(

int

theParam

)

Add parameter for message string of integer type.

Parameters

theParam

the parameter

parameters()

std::list<std::string> Events_InfoMessage::parameters ( ) const

inline

Returns list of parameters.

arg() [1/4]

Events_InfoMessage & Events_InfoMessage::arg

(

const std::wstring &

theParam

)

Add parameter for message string of wstring type.

Parameters

theParam

the parameter

arg() [2/4]

Events_InfoMessage& Events_InfoMessage::arg ( const std::string &  theParam )

inline

Add parameter for message string of string type.

Parameters

theParam

the parameter

arg() [3/4]

Events_InfoMessage& Events_InfoMessage::arg ( int  theParam )

inline

Add parameter for message string of integer type.

Parameters

theParam

the parameter

arg() [4/4]

Events_InfoMessage& Events_InfoMessage::arg ( double  theParam )

inline

Add parameter for message string of double type.

Parameters

theParam

the parameter

send()

void Events_InfoMessage::send

(

)

Send the message.

eventID()

const Events_ID& Events_Message::eventID ( ) const

inlineinherited

Returns identifier of the message.

sender()

void* Events_Message::sender ( ) const

inlineinherited

Returns sender of the message or NULL if it is anonymous message.