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 Types inherited from MyGUI::Window
typedef RTTIBase Base
typedef Window RTTIBase
- Public Types inherited from MyGUI::Widget
typedef Widget RTTIBase
- Public Types inherited from MyGUI::IObject
typedef IObject 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)
- Public Member Functions inherited from MyGUI::Window
 Window ()
virtual void setVisible (bool _value)
 
void setVisibleSmooth (bool _value)
void destroySmooth ()
void setAutoAlpha (bool _value)
bool getAutoAlpha ()
virtual void setCaption (const UString &_value)
virtual const UStringgetCaption ()
WidgetgetCaptionWidget ()
void setMinSize (const IntSize &_value)
void setMinSize (int _width, int _height)
IntSize getMinSize ()
void setMaxSize (const IntSize &_value)
void setMaxSize (int _width, int _height)
IntSize getMaxSize ()
virtual void setPosition (const IntPoint &_value)
 
virtual void setSize (const IntSize &_value)
 
virtual void setCoord (const IntCoord &_value)
 
void setPosition (int _left, int _top)
 
void setSize (int _width, int _height)
 
void setCoord (int _left, int _top, int _width, int _height)
 
bool getSnap ()
void setSnap (bool _value)
void setPosition (const IntCoord &_coord)
void setPosition (int _left, int _top, int _width, int _height)
void showSmooth (bool _reset=false)
void hideSmooth ()
void setMinMax (const IntRect &_minmax)
void setMinMax (int _min_w, int _min_h, int _max_w, int _max_h)
IntRect getMinMax ()
- Public Member Functions inherited from MyGUI::Widget
template<typename Type >
Type * castType (bool _throw=true)
template<typename Type >
const Type * castType (bool _throw=true) const
 Widget ()
WidgetcreateWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
WidgetcreateWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
WidgetcreateWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
WidgetcreateWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
template<typename T >
T * createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
template<typename T >
T * createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
template<typename T >
T * createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
template<typename T >
T * createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
WidgetcreateWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
template<typename T >
T * createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
const std::string & getName () const
 Get name of widget.
void setRealPosition (const FloatPoint &_value)
void setRealSize (const FloatSize &_value)
void setRealCoord (const FloatCoord &_value)
void setRealPosition (float _left, float _top)
void setRealSize (float _width, float _height)
void setRealCoord (float _left, float _top, float _width, float _height)
virtual void setAlign (Align _value)
void setAlpha (float _value)
float getAlpha ()
void setInheritsAlpha (bool _value)
bool isInheritsAlpha ()
bool setState (const std::string &_value)
void setColour (const Colour &_value)
bool isRootWidget ()
WidgetgetParent ()
EnumeratorWidgetPtr getEnumerator ()
size_t getChildCount ()
WidgetgetChildAt (size_t _index)
WidgetfindWidget (const std::string &_name)
void setNeedKeyFocus (bool _value)
bool isNeedKeyFocus ()
void setNeedMouseFocus (bool _value)
bool isNeedMouseFocus ()
void setInheritsPick (bool _value)
bool isInheritsPick ()
void setMaskPick (const std::string &_filename)
virtual void setEnabled (bool _value)
void setEnabledSilent (bool _value)
bool isEnabled ()
void setPointer (const std::string &_value)
const std::string & getPointer ()
const std::string & getLayerName ()
IntCoord getClientCoord ()
WidgetgetClientWidget ()
ISubWidgetTextgetSubWidgetText ()
ISubWidgetRectgetSubWidgetMain ()
void setNeedToolTip (bool _value)
bool getNeedToolTip ()
void setEnableToolTip (bool _value)
bool getEnableToolTip ()
void detachFromWidget (const std::string &_layer="")
void attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")
void changeWidgetSkin (const std::string &_skinname)
void setWidgetStyle (WidgetStyle _style, const std::string &_layer="")
WidgetStyle getWidgetStyle ()
virtual void _getContainer (Widget *&_container, size_t &_index)
void _forcePeek (Widget *_widget)
void _setUVSet (const FloatRect &_rect)
virtual void _setTextureName (const std::string &_texture)
virtual const std::string & _getTextureName ()
IWidgetCreator_getIWidgetCreator ()
IntCoord _getTextRegion ()
IntSize _getTextSize ()
void _setFontName (const std::string &_font)
const std::string & _getFontName ()
void _setFontHeight (int _height)
int _getFontHeight ()
void _setTextAlign (Align _align)
Align _getTextAlign ()
void _setTextColour (const Colour &_colour)
const Colour_getTextColour ()
void setCaptionWithNewLine (const std::string &_value)
void enableToolTip (bool _enable)
void setInheritsPeek (bool _inherits)
bool isInheritsPeek ()
void setMaskPeek (const std::string &_filename)
IntCoord getTextCoord ()
IntSize getTextSize ()
void setFontName (const std::string &_font)
const std::string & getFontName ()
void setFontHeight (int _height)
int getFontHeight ()
void setTextAlign (Align _align)
Align getTextAlign ()
void setTextColour (const Colour &_colour)
const ColourgetTextColour ()
- Public Member Functions inherited from MyGUI::IObject
virtual ~IObject ()
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
virtual ~ICroppedRectangle ()
ICroppedRectanglegetCroppedParent ()
const IntCoordgetCoord () const
IntPoint getPosition () const
IntSize getSize () const
bool isVisible () const
const IntPointgetAbsolutePosition () const
IntRect getAbsoluteRect () const
IntCoord getAbsoluteCoord () const
int getAbsoluteLeft () const
int getAbsoluteTop () const
Align getAlign () const
int getLeft () const
int getRight () const
int getTop () const
int getBottom () const
int getWidth () const
int getHeight () const
bool _isMargin () const
int _getViewLeft () const
int _getViewRight () const
int _getViewTop () const
int _getViewBottom () const
int _getViewWidth () const
int _getViewHeight () const
virtual void _correctView ()
void _setCroppedParent (ICroppedRectangle *_parent)
const IntRect_getMargin () const
int _getMarginLeft () const
int _getMarginRight () const
int _getMarginTop () const
int _getMarginBottom () const
void show ()
void hide ()
bool isShow ()
- Public Member Functions inherited from MyGUI::LayerItem
 LayerItem ()
virtual ~LayerItem ()
ILayergetLayer ()
virtual void attachItemToNode (ILayer *_layer, ILayerNode *_node)
virtual void detachFromLayer ()
virtual void upLayerItem ()
void setRenderItemTexture (ITexture *_texture)
void addChildItem (LayerItem *_item)
void removeChildItem (LayerItem *_item)
void addChildNode (LayerItem *_item)
void removeChildNode (LayerItem *_item)
void addRenderItem (ISubWidget *_item)
void removeAllRenderItems ()
void saveLayerItem ()
void restoreLayerItem ()
- Public Member Functions inherited from MyGUI::ILayerItem
virtual ~ILayerItem ()
- Public Member Functions inherited from MyGUI::UserData
 UserData ()
virtual ~UserData ()
void setUserString (const std::string &_key, const std::string &_value)
const std::string & getUserString (const std::string &_key)
bool clearUserString (const std::string &_key)
bool isUserString (const std::string &_key)
void clearUserStrings ()
void setUserData (Any _data)
template<typename ValueType >
ValueType * getUserData (bool _throw=true)
void _setInternalData (Any _data)
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true)
void * getUserData ()
- Public Member Functions inherited from MyGUI::WidgetEvent
virtual ~WidgetEvent ()
- Public Member Functions inherited from MyGUI::IWidgetCreator
virtual ~IWidgetCreator ()
virtual void _linkChildWidget (Widget *_widget)
virtual void _unlinkChildWidget (Widget *_widget)

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
- Data Fields inherited from MyGUI::Window
EventPair
< EventHandle_WidgetString,
EventHandle_WindowPtrCStringRef
eventWindowButtonPressed
EventPair
< EventHandle_WidgetVoid,
EventHandle_WindowPtr
eventWindowChangeCoord

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)
- Protected Member Functions inherited from MyGUI::Window
virtual ~Window ()
virtual WidgetbaseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name)
void onMouseChangeRootFocus (bool _focus)
void onKeyChangeRootFocus (bool _focus)
void onMouseDrag (int _left, int _top)
void onMouseButtonPressed (int _left, int _top, MouseButton _id)
void notifyMousePressed (MyGUI::Widget *_sender, int _left, int _top, MouseButton _id)
void notifyPressedButtonEvent (MyGUI::Widget *_sender)
void notifyMouseDrag (MyGUI::Widget *_sender, int _left, int _top)
void updateAlpha ()
void animateStop (Widget *_widget)
- Protected Member Functions inherited from MyGUI::Widget
 Widget (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
virtual ~Widget ()
void _updateView ()
void _setAlign (const IntSize &_oldsize, bool _update)
void _setAlign (const IntCoord &_oldcoord, bool _update)
virtual void _destroyChildWidget (Widget *_widget)
virtual void _destroyAllChildWidget ()
virtual size_t _getContainerIndex (const IntPoint &_point)
virtual void _resetContainer (bool _update)
virtual void baseUpdateEnable ()
virtual ILayerItemgetLayerItemByPoint (int _left, int _top)
virtual const IntCoordgetLayerItemCoord ()
- Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool _checkPoint (int _left, int _top)
bool _checkMargin ()
bool _checkOutside ()
- Protected Member Functions inherited from MyGUI::LayerItem
void attachToLayerItemNode (ILayerNode *_node, bool _deep)
void detachFromLayerItemNode (bool _deep)
- Protected Member Functions inherited from MyGUI::WidgetEvent
 WidgetEvent ()
virtual void onMouseLostFocus (Widget *_new)
virtual void onMouseSetFocus (Widget *_old)
virtual void onMouseMove (int _left, int _top)
virtual void onMouseWheel (int _rel)
virtual void onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void onMouseButtonClick ()
virtual void onMouseButtonDoubleClick ()
virtual void onKeyLostFocus (Widget *_new)
virtual void onKeySetFocus (Widget *_old)
virtual void onKeyButtonReleased (KeyCode _key)
- Protected Member Functions inherited from MyGUI::IWidgetCreator
void _deleteWidget (Widget *_widget)

Additional Inherited Members

- Protected Attributes inherited from MyGUI::Widget
MapWidgetStateInfo mStateInfo
MaskPickInfo const * mMaskPickInfo
MaskPickInfo mOwnMaskPickInfo
VectorWidgetPtr mWidgetChild
VectorWidgetPtr mWidgetChildSkin
VectorSubWidget mSubSkinChild
ISubWidgetTextmText
ISubWidgetRectmMainSkin
bool mEnabled
bool mInheritsEnabled
bool mSubSkinsVisible
bool mInheritsVisible
float mAlpha
float mRealAlpha
bool mInheritsAlpha
std::string mName
std::string mPointer
std::string mTextureName
ITexturemTexture
WidgetmParent
IWidgetCreatormIWidgetCreator
bool mNeedKeyFocus
bool mNeedMouseFocus
bool mInheritsPick
WidgetmWidgetClient
bool mNeedToolTip
bool mEnableToolTip
bool mToolTipVisible
float mToolTipCurrentTime
IntPoint mToolTipOldPoint
size_t mToolTipOldIndex
IntPoint m_oldMousePoint
WidgetStyle mWidgetStyle
FloatCoord mRelativeCoord
bool mDisableUpdateRelative

Detailed Description

Definition at line 38 of file MyGUI_Message.h.

Member Typedef Documentation

Definition at line 41 of file MyGUI_Message.h.

Definition at line 41 of file MyGUI_Message.h.

Constructor & Destructor Documentation

MyGUI::Message::Message ( )

Definition at line 42 of file MyGUI_Message.cpp.

MyGUI::Message::~Message ( )
protectedvirtual

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.

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

Create button with specific name

Definition at line 133 of file MyGUI_Message.cpp.

void MyGUI::Message::baseChangeWidgetSkin ( ResourceSkin _info)
protectedvirtual

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.

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

Definition at line 422 of file MyGUI_Message.cpp.

void MyGUI::Message::endMessage ( )

Definition at line 427 of file MyGUI_Message.cpp.

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

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

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
inlinevirtual

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
inlinevirtual

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 
)
protectedvirtual

Reimplemented from MyGUI::WidgetEvent.

Definition at line 219 of file MyGUI_Message.cpp.

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

Create button using MessageBoxStyle

Definition at line 173 of file MyGUI_Message.cpp.

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

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.

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

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

EventHandle_MessagePtrMessageStyle MyGUI::Message::eventMessageBoxResult

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: