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

#include <MyGUI_Window.h>

+ Inheritance diagram for MyGUI::Window:

Public Types

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

Data Fields

EventPair
< EventHandle_WidgetString,
EventHandle_WindowPtrCStringRef
eventWindowButtonPressed
EventPair
< EventHandle_WidgetVoid,
EventHandle_WindowPtr
eventWindowChangeCoord

Protected Member Functions

virtual ~Window ()
void baseChangeWidgetSkin (ResourceSkin *_info)
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 onKeyButtonPressed (KeyCode _key, Char _char)
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 39 of file MyGUI_Window.h.

Member Typedef Documentation

Definition at line 42 of file MyGUI_Window.h.

Definition at line 42 of file MyGUI_Window.h.

Constructor & Destructor Documentation

MyGUI::Window::Window ( )

Definition at line 42 of file MyGUI_Window.cpp.

MyGUI::Window::~Window ( )
protectedvirtual

Definition at line 59 of file MyGUI_Window.cpp.

Member Function Documentation

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

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Definition at line 52 of file MyGUI_Window.cpp.

void MyGUI::Window::animateStop ( Widget _widget)
protected

Definition at line 334 of file MyGUI_Window.cpp.

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

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Definition at line 64 of file MyGUI_Window.cpp.

Widget * MyGUI::Window::baseCreateWidget ( WidgetStyle  _style,
const std::string &  _type,
const std::string &  _skin,
const IntCoord _coord,
Align  _align,
const std::string &  _layer,
const std::string &  _name 
)
protectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 134 of file MyGUI_Window.cpp.

void MyGUI::Window::destroySmooth ( )

Hide window smooth and then destroy it

Definition at line 327 of file MyGUI_Window.cpp.

bool MyGUI::Window::getAutoAlpha ( )
inline

Get auto alpha mode flag

Definition at line 58 of file MyGUI_Window.h.

const UString & MyGUI::Window::getCaption ( )
virtual

Get window caption

Reimplemented from MyGUI::Widget.

Definition at line 321 of file MyGUI_Window.cpp.

Widget* MyGUI::Window::getCaptionWidget ( )
inline

Get window caption widget

Definition at line 66 of file MyGUI_Window.h.

static const std::string& MyGUI::Window::getClassTypeName ( )
inlinestatic

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Definition at line 42 of file MyGUI_Window.h.

IntSize MyGUI::Window::getMaxSize ( )

Get maximal possible window size

Definition at line 432 of file MyGUI_Window.cpp.

IntRect MyGUI::Window::getMinMax ( )
inline
Deprecated:
"use : IntSize getMinSize() , IntSize getMaxSize()"

Definition at line 137 of file MyGUI_Window.h.

IntSize MyGUI::Window::getMinSize ( )

Get minimal possible window size

Definition at line 421 of file MyGUI_Window.cpp.

bool MyGUI::Window::getSnap ( )
inline

Get snap to borders mode flag

Definition at line 97 of file MyGUI_Window.h.

virtual const std::string& MyGUI::Window::getTypeName ( ) const
inlinevirtual

Get type name as string

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Definition at line 42 of file MyGUI_Window.h.

void MyGUI::Window::hideSmooth ( )
inline
Deprecated:
"use : void setVisibleSmooth(bool _visible)"

Definition at line 131 of file MyGUI_Window.h.

template<typename Type >
bool MyGUI::Window::isType ( ) const
inline

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Definition at line 42 of file MyGUI_Window.h.

virtual bool MyGUI::Window::isType ( const std::type_info &  _type) const
inlinevirtual

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Definition at line 42 of file MyGUI_Window.h.

void MyGUI::Window::notifyMouseDrag ( MyGUI::Widget _sender,
int  _left,
int  _top 
)
protected

Definition at line 186 of file MyGUI_Window.cpp.

void MyGUI::Window::notifyMousePressed ( MyGUI::Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
)
protected

Definition at line 172 of file MyGUI_Window.cpp.

void MyGUI::Window::notifyPressedButtonEvent ( MyGUI::Widget _sender)
protected

Definition at line 181 of file MyGUI_Window.cpp.

void MyGUI::Window::onKeyChangeRootFocus ( bool  _focus)
protectedvirtual

Reimplemented from MyGUI::WidgetEvent.

Definition at line 149 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseButtonPressed ( int  _left,
int  _top,
MouseButton  _id 
)
protectedvirtual

Reimplemented from MyGUI::WidgetEvent.

Definition at line 165 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseChangeRootFocus ( bool  _focus)
protectedvirtual

Reimplemented from MyGUI::WidgetEvent.

Definition at line 141 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseDrag ( int  _left,
int  _top 
)
protectedvirtual

Reimplemented from MyGUI::WidgetEvent.

Definition at line 157 of file MyGUI_Window.cpp.

void MyGUI::Window::setAutoAlpha ( bool  _value)

Enable or disable auto alpha mode

Definition at line 220 of file MyGUI_Window.cpp.

void MyGUI::Window::setCaption ( const UString _value)
virtual

Set window caption

Reimplemented from MyGUI::Widget.

Definition at line 315 of file MyGUI_Window.cpp.

void MyGUI::Window::setCoord ( const IntCoord _value)
virtual

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 267 of file MyGUI_Window.cpp.

void MyGUI::Window::setCoord ( int  _left,
int  _top,
int  _width,
int  _height 
)
inline

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 94 of file MyGUI_Window.h.

void MyGUI::Window::setMaxSize ( const IntSize _value)

Set maximal possible window size

Definition at line 426 of file MyGUI_Window.cpp.

void MyGUI::Window::setMaxSize ( int  _width,
int  _height 
)
inline

Set maximal possible window size

Definition at line 78 of file MyGUI_Window.h.

void MyGUI::Window::setMinMax ( const IntRect _minmax)
inline
Deprecated:
"use : void setMinSize(const IntSize& _min) , void setMaxSize(const IntSize& _min)"

Definition at line 133 of file MyGUI_Window.h.

void MyGUI::Window::setMinMax ( int  _min_w,
int  _min_h,
int  _max_w,
int  _max_h 
)
inline
Deprecated:
"use : void setMinSize(const IntSize& _min) , void setMaxSize(const IntSize& _min)"

Definition at line 135 of file MyGUI_Window.h.

void MyGUI::Window::setMinSize ( const IntSize _value)

Set minimal possible window size

Definition at line 415 of file MyGUI_Window.cpp.

void MyGUI::Window::setMinSize ( int  _width,
int  _height 
)
inline

Set minimal possible window size

Definition at line 71 of file MyGUI_Window.h.

void MyGUI::Window::setPosition ( const IntPoint _value)
virtual

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 232 of file MyGUI_Window.cpp.

void MyGUI::Window::setPosition ( int  _left,
int  _top 
)
inline

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 90 of file MyGUI_Window.h.

void MyGUI::Window::setPosition ( const IntCoord _coord)
inline
Deprecated:
"use : void Widget::setCoord(const IntCoord& _coord)"

Reimplemented from MyGUI::Widget.

Definition at line 125 of file MyGUI_Window.h.

void MyGUI::Window::setPosition ( int  _left,
int  _top,
int  _width,
int  _height 
)
inline
Deprecated:
"use : void Widget::setCoord(int _left, int _top, int _width, int _height)"

Reimplemented from MyGUI::Widget.

Definition at line 127 of file MyGUI_Window.h.

void MyGUI::Window::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::Widget.

Reimplemented in MyGUI::Message.

Definition at line 437 of file MyGUI_Window.cpp.

void MyGUI::Window::setSize ( const IntSize _value)
virtual

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 246 of file MyGUI_Window.cpp.

void MyGUI::Window::setSize ( int  _width,
int  _height 
)
inline

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 92 of file MyGUI_Window.h.

void MyGUI::Window::setSnap ( bool  _value)
inline

Enable or disable snap to borders mode

Definition at line 99 of file MyGUI_Window.h.

void MyGUI::Window::setVisible ( bool  _value)
virtual

Hide or show widget

Reimplemented from MyGUI::Widget.

Definition at line 343 of file MyGUI_Window.cpp.

void MyGUI::Window::setVisibleSmooth ( bool  _value)

Hide or show window smooth

Definition at line 377 of file MyGUI_Window.cpp.

void MyGUI::Window::showSmooth ( bool  _reset = false)
inline
Deprecated:
"use : void setVisibleSmooth(bool _visible)"

Definition at line 129 of file MyGUI_Window.h.

void MyGUI::Window::updateAlpha ( )
protected

Definition at line 207 of file MyGUI_Window.cpp.

Field Documentation

EventPair<EventHandle_WidgetString, EventHandle_WindowPtrCStringRef> MyGUI::Window::eventWindowButtonPressed

Event : Window button pressed.
signature : void method(MyGUI::Window* _sender, const std::string& _name)

Parameters
_senderwidget that called this event
_nameof pressed button

Definition at line 110 of file MyGUI_Window.h.

EventPair<EventHandle_WidgetVoid, EventHandle_WindowPtr> MyGUI::Window::eventWindowChangeCoord

Event : Window coordinate changed (window was resized or moved).
signature : void method(MyGUI::Window* _sender)

Parameters
_senderwidget that called this event

Definition at line 116 of file MyGUI_Window.h.


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