MyGUI 3.4.3
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 std::string_view getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
void setTime (float _value)
 
void setRemainPixels (int _value)
 
void setShadowSize (int _value)
 
bool addTime (Widget *_widget, float _time) override
 
void prepareItem (Widget *_widget) override
 
void setProperty (std::string_view _key, std::string_view _value) override
 
- Public Member Functions inherited from MyGUI::ControllerItem
template<typename Type >
bool isType () const
 
- Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool isType () const
 
template<typename Type >
Type * castType (bool _throw=true)
 
template<typename Type >
const Type * castType (bool _throw=true) const
 
virtual ~IObject ()=default
 

Static Public Member Functions

static std::string_view getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::ControllerItem
static std::string_view getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::IObject
static std::string_view getClassTypeName ()
 

Additional Inherited Members

- Data Fields inherited from MyGUI::ControllerItem
EventPairAddParameter< EventHandle_WidgetPtr, EventHandle_WidgetPtrControllerItemPtreventPreAction
 
EventPairAddParameter< EventHandle_WidgetPtr, EventHandle_WidgetPtrControllerItemPtreventUpdateAction
 
EventPairAddParameter< EventHandle_WidgetPtr, EventHandle_WidgetPtrControllerItemPtreventPostAction
 

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 24 of file MyGUI_ControllerEdgeHide.h.

Member Typedef Documentation

◆ Base

◆ RTTIBase

Member Function Documentation

◆ addTime()

bool MyGUI::ControllerEdgeHide::addTime ( Widget * _widget,
float _time )
overridevirtual

Implements MyGUI::ControllerItem.

Definition at line 29 of file MyGUI_ControllerEdgeHide.cpp.

◆ getClassTypeName()

static std::string_view MyGUI::ControllerEdgeHide::getClassTypeName ( )
inlinestatic

Definition at line 26 of file MyGUI_ControllerEdgeHide.h.

◆ getTypeName()

virtual std::string_view MyGUI::ControllerEdgeHide::getTypeName ( ) const
inlineoverridevirtual

Get type name as string

Reimplemented from MyGUI::ControllerItem.

Definition at line 26 of file MyGUI_ControllerEdgeHide.h.

◆ isType() [1/2]

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

Compare with selected type

Definition at line 26 of file MyGUI_ControllerEdgeHide.h.

◆ isType() [2/2]

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

Compare with selected type

Reimplemented from MyGUI::ControllerItem.

Definition at line 26 of file MyGUI_ControllerEdgeHide.h.

◆ prepareItem()

void MyGUI::ControllerEdgeHide::prepareItem ( Widget * _widget)
overridevirtual

Implements MyGUI::ControllerItem.

Definition at line 22 of file MyGUI_ControllerEdgeHide.cpp.

◆ setProperty()

void MyGUI::ControllerEdgeHide::setProperty ( std::string_view _key,
std::string_view _value )
overridevirtual

Reimplemented from MyGUI::ControllerItem.

Definition at line 117 of file MyGUI_ControllerEdgeHide.cpp.

◆ setRemainPixels()

void MyGUI::ControllerEdgeHide::setRemainPixels ( int _value)
Parameters
_valueHow many pixels you will see after full hide

Definition at line 168 of file MyGUI_ControllerEdgeHide.cpp.

◆ setShadowSize()

void MyGUI::ControllerEdgeHide::setShadowSize ( int _value)
Parameters
_valueAdded to "remain pixels" when hiding left or top (for example used for windows with shadows)

Definition at line 173 of file MyGUI_ControllerEdgeHide.cpp.

◆ setTime()

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

Definition at line 163 of file MyGUI_ControllerEdgeHide.cpp.


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