SGUIMessage Struct Reference

Message send to IGUIObject::HandleMessage() in order to give life to Objects manually with a derived HandleMessage(). More...

#include <SGUIMessage.h>

Public Member Functions
	NONCOPYABLE (SGUIMessage)
	SGUIMessage (EGUIMessageType _type)
	SGUIMessage (EGUIMessageType _type, const CStr &_value)
void	Skip (bool skip=true)
	This method can be used to allow other event handlers to process this GUI event, by default an event is not skipped (only the first handler will process it). More...

Public Attributes
EGUIMessageType	type
	Describes what the message regards. More...
CStr	value
	Optional data. More...
bool	skipped
	Flag that specifies if object skipped handling the event. More...

Detailed Description

Message send to IGUIObject::HandleMessage() in order to give life to Objects manually with a derived HandleMessage().

Constructor & Destructor Documentation

SGUIMessage() [1/2]

SGUIMessage::SGUIMessage ( EGUIMessageType  _type )

inline

SGUIMessage() [2/2]

SGUIMessage::SGUIMessage ( EGUIMessageType  _type, const CStr &  _value  )

inline

Member Function Documentation

NONCOPYABLE()

SGUIMessage::NONCOPYABLE

(

SGUIMessage

)

Skip()

void SGUIMessage::Skip ( bool  skip = true )

inline

This method can be used to allow other event handlers to process this GUI event, by default an event is not skipped (only the first handler will process it).

Parameters

skip	true to allow further event handling, false to prevent it

Member Data Documentation

skipped

bool SGUIMessage::skipped

Flag that specifies if object skipped handling the event.

type

EGUIMessageType SGUIMessage::type

Describes what the message regards.

value

CStr SGUIMessage::value

Optional data.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/gui/SGUIMessage.h