MyGUI  3.0.1
Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions
MyGUI::Message Class Reference

#include <MyGUI_Message.h>

+ Inheritance diagram for MyGUI::Message:

Public Types

typedef RTTIBase Base
typedef Message RTTIBase

Public Member Functions

virtual const std::string & getTypeName () const
virtual bool isType (const std::type_info &_type) const
template<typename Type >
bool isType () const
 Message ()
void setMessageText (const UString &_value)
MessageBoxStyle addButtonName (const UString &_name)
void setSmoothShow (bool _value)
const std::string & getDefaultLayer ()
void setMessageIcon (MessageBoxStyle _value)
void setWindowFade (bool _value)
void endMessage (MessageBoxStyle _result)
void endMessage ()
void setMessageButton (MessageBoxStyle _value)
void setMessageStyle (MessageBoxStyle _value)
void setMessageModal (bool _value)
virtual void setProperty (const std::string &_key, const std::string &_value)
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)

Static Public Member Functions

static const std::string & getClassTypeName ()
static MyGUI::MessagecreateMessageBox (const std::string &_skin, const UString &_caption, const UString &_message, MessageBoxStyle _style=MessageBoxStyle::Ok|MessageBoxStyle::IconDefault, const std::string &_layer="", bool _modal=true, const std::string &_button1="", const std::string &_button2="", const std::string &_button3="", const std::string &_button4="")

Data Fields

EventHandle_MessagePtrMessageStyle eventMessageBoxResult

Protected Member Functions

virtual ~Message ()
void baseChangeWidgetSkin (ResourceSkin *_info)
void updateSize ()
void notifyButtonClick (MyGUI::Widget *_sender)
void clearButton ()
void onKeyButtonPressed (KeyCode _key, Char _char)
void _destroyMessage (MessageBoxStyle _result)
UString getButtonName (MessageBoxStyle _style)
const char * getIconName (size_t _index)
const char * getButtonName (size_t _index)
const char * getButtonTag (size_t _index)

Detailed Description

Definition at line 38 of file MyGUI_Message.h.


Member Typedef Documentation

Reimplemented from MyGUI::Window.

Definition at line 41 of file MyGUI_Message.h.

Reimplemented from MyGUI::Window.

Definition at line 41 of file MyGUI_Message.h.


Constructor & Destructor Documentation

Definition at line 42 of file MyGUI_Message.cpp.

MyGUI::Message::~Message ( ) [protected, virtual]

Definition at line 61 of file MyGUI_Message.cpp.


Member Function Documentation

void MyGUI::Message::_destroyMessage ( MessageBoxStyle  _result) [protected]

Definition at line 226 of file MyGUI_Message.cpp.

void MyGUI::Message::_initialise ( WidgetStyle  _style,
const IntCoord _coord,
Align  _align,
ResourceSkin _info,
Widget _parent,
ICroppedRectangle _croppedParent,
IWidgetCreator _creator,
const std::string &  _name 
) [virtual]

Reimplemented from MyGUI::Window.

Definition at line 54 of file MyGUI_Message.cpp.

Create button with specific name

Definition at line 133 of file MyGUI_Message.cpp.

void MyGUI::Message::baseChangeWidgetSkin ( ResourceSkin _info) [protected, virtual]

Reimplemented from MyGUI::Window.

Definition at line 66 of file MyGUI_Message.cpp.

void MyGUI::Message::clearButton ( ) [protected]

Definition at line 210 of file MyGUI_Message.cpp.

MyGUI::Message * MyGUI::Message::createMessageBox ( const std::string &  _skin,
const UString _caption,
const UString _message,
MessageBoxStyle  _style = MessageBoxStyle::Ok | MessageBoxStyle::IconDefault,
const std::string &  _layer = "",
bool  _modal = true,
const std::string &  _button1 = "",
const std::string &  _button2 = "",
const std::string &  _button3 = "",
const std::string &  _button4 = "" 
) [static]

Static method for creating message with one command

Parameters:
_modalif true all other GUI elements will be blocked untill message is closed
_styleany combination of flags from ViewValueInfo
_button1... _button4 specific buttons names

Definition at line 298 of file MyGUI_Message.cpp.

Definition at line 422 of file MyGUI_Message.cpp.

Definition at line 427 of file MyGUI_Message.cpp.

Definition at line 397 of file MyGUI_Message.cpp.

const char * MyGUI::Message::getButtonName ( size_t  _index) [protected]

Definition at line 406 of file MyGUI_Message.cpp.

const char * MyGUI::Message::getButtonTag ( size_t  _index) [protected]

Definition at line 414 of file MyGUI_Message.cpp.

static const std::string& MyGUI::Message::getClassTypeName ( ) [inline, static]

Reimplemented from MyGUI::Window.

Definition at line 41 of file MyGUI_Message.h.

const std::string& MyGUI::Message::getDefaultLayer ( ) [inline]

Get name of default layer for Message

Definition at line 56 of file MyGUI_Message.h.

const char * MyGUI::Message::getIconName ( size_t  _index) [protected]

Definition at line 290 of file MyGUI_Message.cpp.

virtual const std::string& MyGUI::Message::getTypeName ( ) const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::Window.

Definition at line 41 of file MyGUI_Message.h.

template<typename Type >
bool MyGUI::Message::isType ( ) const [inline]

Compare with selected type

Reimplemented from MyGUI::Window.

Definition at line 41 of file MyGUI_Message.h.

virtual bool MyGUI::Message::isType ( const std::type_info &  _type) const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::Window.

Definition at line 41 of file MyGUI_Message.h.

void MyGUI::Message::notifyButtonClick ( MyGUI::Widget _sender) [protected]

Definition at line 205 of file MyGUI_Message.cpp.

void MyGUI::Message::onKeyButtonPressed ( KeyCode  _key,
Char  _char 
) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 219 of file MyGUI_Message.cpp.

Create button using MessageBoxStyle

Definition at line 173 of file MyGUI_Message.cpp.

Set message icon

Definition at line 158 of file MyGUI_Message.cpp.

void MyGUI::Message::setMessageModal ( bool  _value)

Definition at line 391 of file MyGUI_Message.cpp.

Set message style (button and icon)

Definition at line 199 of file MyGUI_Message.cpp.

void MyGUI::Message::setMessageText ( const UString _value)

Set message text

Definition at line 126 of file MyGUI_Message.cpp.

void MyGUI::Message::setProperty ( const std::string &  _key,
const std::string &  _value 
) [virtual]

Set any widget property

Parameters:
_keyProperty name (for example Widget_Alpha or Edit_MultiLine)
_valueValue converted to string

Reimplemented from MyGUI::Window.

Definition at line 432 of file MyGUI_Message.cpp.

void MyGUI::Message::setSmoothShow ( bool  _value)

Set smooth message showing

Definition at line 246 of file MyGUI_Message.cpp.

void MyGUI::Message::setWindowFade ( bool  _value)

Set fade under message

Definition at line 257 of file MyGUI_Message.cpp.

void MyGUI::Message::updateSize ( ) [protected]

Definition at line 339 of file MyGUI_Message.cpp.


Field Documentation

Event : button on message window pressed.
signature : void method(MyGUI::Message* _sender, MyGUI::MessageBoxStyle _result)

Parameters:
_senderwidget that called this event
_result- id of pressed button

Definition at line 104 of file MyGUI_Message.h.


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