MyGUI  3.0.1
Public Types | Public Member Functions | Static Public Member Functions
MyGUI::ControllerEdgeHide Class Reference

#include <MyGUI_ControllerEdgeHide.h>

+ Inheritance diagram for MyGUI::ControllerEdgeHide:

Public Types

typedef RTTIBase Base
typedef ControllerEdgeHide RTTIBase
- Public Types inherited from MyGUI::ControllerItem
typedef RTTIBase Base
typedef ControllerItem 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
 ControllerEdgeHide ()
virtual ~ControllerEdgeHide ()
void setTime (float _value)
void setRemainPixels (int _value)
void setShadowSize (int _value)
virtual void setProperty (const std::string &_key, const std::string &_value)
- Public Member Functions inherited from MyGUI::ControllerItem
virtual ~ControllerItem ()
virtual void prepareItem (Widget *_widget)=0
virtual bool addTime (Widget *_widget, float _time)=0
- Public Member Functions inherited from MyGUI::IObject
template<typename Type >
Type * castType (bool _throw=true)
template<typename Type >
const Type * castType (bool _throw=true) const
virtual ~IObject ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Additional Inherited Members

- Data Fields inherited from MyGUI::ControllerItem
delegates::CDelegate1< Widget * > eventPreAction
delegates::CDelegate1< Widget * > eventUpdateAction
delegates::CDelegate1< Widget * > eventPostAction

Detailed Description

This controller used for hiding widgets near screen edges. Widget will start hiding(move out of screen) if it's near border and it and it's childrens don't have any focus. Hiding till only small part of widget be visible. Widget will move inside screen if it have any focus.

Definition at line 40 of file MyGUI_ControllerEdgeHide.h.

Member Typedef Documentation

Definition at line 43 of file MyGUI_ControllerEdgeHide.h.

Definition at line 43 of file MyGUI_ControllerEdgeHide.h.

Constructor & Destructor Documentation

MyGUI::ControllerEdgeHide::ControllerEdgeHide ( )

Definition at line 37 of file MyGUI_ControllerEdgeHide.cpp.

virtual MyGUI::ControllerEdgeHide::~ControllerEdgeHide ( )
inlinevirtual

Definition at line 47 of file MyGUI_ControllerEdgeHide.h.

Member Function Documentation

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

Reimplemented from MyGUI::ControllerItem.

Definition at line 43 of file MyGUI_ControllerEdgeHide.h.

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

Get type name as string

Reimplemented from MyGUI::ControllerItem.

Definition at line 43 of file MyGUI_ControllerEdgeHide.h.

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

Compare with selected type

Reimplemented from MyGUI::ControllerItem.

Definition at line 43 of file MyGUI_ControllerEdgeHide.h.

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

Compare with selected type

Reimplemented from MyGUI::ControllerItem.

Definition at line 43 of file MyGUI_ControllerEdgeHide.h.

void MyGUI::ControllerEdgeHide::setProperty ( const std::string &  _key,
const std::string &  _value 
)
virtual

Reimplemented from MyGUI::ControllerItem.

Definition at line 136 of file MyGUI_ControllerEdgeHide.cpp.

void MyGUI::ControllerEdgeHide::setRemainPixels ( int  _value)
inline
Parameters
_remainPixelshow many pixels you will see afterr full hide

Definition at line 57 of file MyGUI_ControllerEdgeHide.h.

void MyGUI::ControllerEdgeHide::setShadowSize ( int  _value)
inline
Parameters
_shadowSizeadds to _remainPixels when hiding left or top (for example used for windows with shadows)

Definition at line 62 of file MyGUI_ControllerEdgeHide.h.

void MyGUI::ControllerEdgeHide::setTime ( float  _value)
inline
Parameters
_valuein which widget will be hidden or shown

Definition at line 52 of file MyGUI_ControllerEdgeHide.h.


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