Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
SGUIMessage Struct Reference

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

#include <GUIbase.h>

Public Member Functions

 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().

Definition at line 106 of file GUIbase.h.

Constructor & Destructor Documentation

SGUIMessage::SGUIMessage ( EGUIMessageType  _type)
inline

Definition at line 108 of file GUIbase.h.

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

Definition at line 109 of file GUIbase.h.

Member Function Documentation

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
skiptrue to allow further event handling, false to prevent it

Definition at line 117 of file GUIbase.h.

Member Data Documentation

bool SGUIMessage::skipped

Flag that specifies if object skipped handling the event.

Definition at line 132 of file GUIbase.h.

EGUIMessageType SGUIMessage::type

Describes what the message regards.

Definition at line 122 of file GUIbase.h.

CStr SGUIMessage::value

Optional data.

Definition at line 127 of file GUIbase.h.


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