MyGUI::Message Class Reference

#include <MyGUI_Message.h>

Inheritance diagram for MyGUI::Message:
Inheritance graph
[legend]

Public Member Functions

 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, WidgetPtr _parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)

Static Public Member Functions

static MyGUI::MessagePtr 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="")

Data Fields

EventHandle_MessagePtrMessageStyle eventMessageBoxResult

Protected Member Functions

virtual ~Message ()
void baseChangeWidgetSkin (ResourceSkin *_info)
void updateSize ()
void notifyButtonClick (MyGUI::WidgetPtr _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.


Constructor & Destructor Documentation

MyGUI::Message::Message (  ) 

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 225 of file MyGUI_Message.cpp.

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

Reimplemented from MyGUI::Window.

Definition at line 54 of file MyGUI_Message.cpp.

MessageBoxStyle MyGUI::Message::addButtonName ( const UString _name  ) 

Create button with specific name

Definition at line 132 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 209 of file MyGUI_Message.cpp.

MyGUI::MessagePtr 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:
_modal if true all other GUI elements will be blocked untill message is closed
_style any combination of flags from ViewValueInfo
_button1 ... _button4 specific buttons names

Definition at line 297 of file MyGUI_Message.cpp.

void MyGUI::Message::endMessage (  ) 

Definition at line 421 of file MyGUI_Message.cpp.

void MyGUI::Message::endMessage ( MessageBoxStyle  _result  ) 

Definition at line 416 of file MyGUI_Message.cpp.

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

Definition at line 400 of file MyGUI_Message.cpp.

UString MyGUI::Message::getButtonName ( MessageBoxStyle  _style  )  [protected]

Definition at line 391 of file MyGUI_Message.cpp.

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

Definition at line 408 of file MyGUI_Message.cpp.

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 289 of file MyGUI_Message.cpp.

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

Definition at line 204 of file MyGUI_Message.cpp.

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

Reimplemented from MyGUI::WidgetEvent.

Definition at line 218 of file MyGUI_Message.cpp.

void MyGUI::Message::setMessageButton ( MessageBoxStyle  _value  ) 

Create button using MessageBoxStyle

Definition at line 172 of file MyGUI_Message.cpp.

void MyGUI::Message::setMessageIcon ( MessageBoxStyle  _value  ) 

Set message icon

Definition at line 157 of file MyGUI_Message.cpp.

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

Definition at line 385 of file MyGUI_Message.cpp.

void MyGUI::Message::setMessageStyle ( MessageBoxStyle  _value  ) 

Set message style (button and icon)

Definition at line 198 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]

Reimplemented from MyGUI::Window.

Definition at line 426 of file MyGUI_Message.cpp.

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

Set smooth message showing

Definition at line 245 of file MyGUI_Message.cpp.

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

Set fade under message

Definition at line 256 of file MyGUI_Message.cpp.

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

Definition at line 338 of file MyGUI_Message.cpp.


Field Documentation

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

Parameters:
_sender widget 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:

Generated on 5 Dec 2009 for MyGUI by  doxygen 1.6.1