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

Window properties. Skin childs. Window widget description should be here. More...

#include <MyGUI_Window.h>

+ Inheritance diagram for MyGUI::Window:

Public Types

typedef RTTIBase Base
typedef Window 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 () const
virtual void setCaption (const UString &_value)
virtual const UStringgetCaption ()
TextBoxgetCaptionWidget ()
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)
void setSnap (bool _value)
bool getSnap () const
const IntCoordgetActionScale () const
void setMovable (bool _value)
bool getMovable () const

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 void initialiseOverride ()
virtual void shutdownOverride ()
void onMouseChangeRootFocus (bool _focus)
void onKeyChangeRootFocus (bool _focus)
void onMouseDrag (int _left, int _top, MouseButton _id)
void onMouseButtonPressed (int _left, int _top, MouseButton _id)
void onMouseButtonReleased (int _left, int _top, MouseButton _id)
void notifyMousePressed (MyGUI::Widget *_sender, int _left, int _top, MouseButton _id)
void notifyMouseReleased (MyGUI::Widget *_sender, int _left, int _top, MouseButton _id)
void notifyPressedButtonEvent (MyGUI::Widget *_sender)
void notifyMouseDrag (MyGUI::Widget *_sender, int _left, int _top, MouseButton _id)
void notifyMouseWheel (MyGUI::Widget *_sender, int _rel)
void updateAlpha ()
void animateStop (Widget *_widget, ControllerItem *_controller)
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)

Detailed Description

Window properties. Skin childs. Window widget description should be here.

Definition at line 27 of file MyGUI_Window.h.


Member Typedef Documentation

Reimplemented from MyGUI::TextBox.

Definition at line 31 of file MyGUI_Window.h.

Reimplemented from MyGUI::TextBox.

Definition at line 31 of file MyGUI_Window.h.


Constructor & Destructor Documentation

Definition at line 25 of file MyGUI_Window.cpp.


Member Function Documentation

void MyGUI::Window::animateStop ( Widget _widget,
ControllerItem _controller 
) [protected]

Definition at line 358 of file MyGUI_Window.cpp.

Hide window smooth and then destroy it

Definition at line 351 of file MyGUI_Window.cpp.

Get current action applied to move/resize window.

Definition at line 489 of file MyGUI_Window.cpp.

Get auto alpha mode flag

Definition at line 494 of file MyGUI_Window.cpp.

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

Get window caption

Reimplemented from MyGUI::TextBox.

Definition at line 344 of file MyGUI_Window.cpp.

Get window caption widget

Definition at line 499 of file MyGUI_Window.cpp.

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

Reimplemented from MyGUI::TextBox.

Definition at line 31 of file MyGUI_Window.h.

Get maximal possible window size

Definition at line 453 of file MyGUI_Window.cpp.

Get minimal possible window size

Definition at line 442 of file MyGUI_Window.cpp.

bool MyGUI::Window::getMovable ( ) const

Get possibility to move window.

Definition at line 603 of file MyGUI_Window.cpp.

bool MyGUI::Window::getSnap ( ) const

Get snap to borders mode flag

Definition at line 529 of file MyGUI_Window.cpp.

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

Get type name as string

Reimplemented from MyGUI::TextBox.

Definition at line 31 of file MyGUI_Window.h.

void MyGUI::Window::initialiseOverride ( ) [protected, virtual]
skin clilds:
Client is child widget with type Widget. Клиентская зона.
skin clilds:
Caption is child widget with type TextBox. Caption for window.

Reimplemented from MyGUI::Widget.

Definition at line 37 of file MyGUI_Window.cpp.

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

Compare with selected type

Reimplemented from MyGUI::TextBox.

Definition at line 31 of file MyGUI_Window.h.

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

Compare with selected type

Reimplemented from MyGUI::TextBox.

Definition at line 31 of file MyGUI_Window.h.

void MyGUI::Window::notifyMouseDrag ( MyGUI::Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]

Definition at line 179 of file MyGUI_Window.cpp.

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

Definition at line 165 of file MyGUI_Window.cpp.

void MyGUI::Window::notifyMouseReleased ( MyGUI::Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]

Definition at line 539 of file MyGUI_Window.cpp.

void MyGUI::Window::notifyMouseWheel ( MyGUI::Widget _sender,
int  _rel 
) [protected]

Definition at line 608 of file MyGUI_Window.cpp.

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

Definition at line 174 of file MyGUI_Window.cpp.

void MyGUI::Window::onKeyChangeRootFocus ( bool  _focus) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 135 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseButtonPressed ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 151 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseButtonReleased ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 158 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseChangeRootFocus ( bool  _focus) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 127 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseDrag ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 143 of file MyGUI_Window.cpp.

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

Enable or disable auto alpha mode

Definition at line 223 of file MyGUI_Window.cpp.

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

Set window caption

Reimplemented from MyGUI::TextBox.

Definition at line 336 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 279 of file MyGUI_Window.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 524 of file MyGUI_Window.cpp.

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

Set maximal possible window size

Definition at line 447 of file MyGUI_Window.cpp.

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

Set maximal possible window size

Definition at line 509 of file MyGUI_Window.cpp.

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

Set minimal possible window size

Definition at line 436 of file MyGUI_Window.cpp.

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

Set minimal possible window size

Definition at line 504 of file MyGUI_Window.cpp.

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

Enable or disable possibility to move window.

Definition at line 598 of file MyGUI_Window.cpp.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 239 of file MyGUI_Window.cpp.

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

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 514 of file MyGUI_Window.cpp.

void MyGUI::Window::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]
Properties:
AutoAlpha is Window property with type bool. Режим регулировки прозрачности опираясь на фокус ввода.
Properties:
Snap is Window property with type bool. Режим прилипания к краям экрана.
Properties:
MinSize is Window property with type int int. Минимальный размер окна.
Properties:
MaxSize is Window property with type int int. Максимальный размер окна.
Properties:
Movable is Window property with type bool. Режим движения окна мышью за любой участок.

Reimplemented from MyGUI::TextBox.

Definition at line 458 of file MyGUI_Window.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 253 of file MyGUI_Window.cpp.

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

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 519 of file MyGUI_Window.cpp.

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

Enable or disable snap to borders mode

Definition at line 534 of file MyGUI_Window.cpp.

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

Hide or show widget

Reimplemented from MyGUI::Widget.

Definition at line 367 of file MyGUI_Window.cpp.

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

Hide or show window smooth

Definition at line 398 of file MyGUI_Window.cpp.

void MyGUI::Window::shutdownOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 119 of file MyGUI_Window.cpp.

void MyGUI::Window::updateAlpha ( ) [protected]

Definition at line 206 of file MyGUI_Window.cpp.


Field Documentation

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 104 of file MyGUI_Window.h.

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

Parameters:
_senderwidget that called this event

Definition at line 110 of file MyGUI_Window.h.


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