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

#include <MyGUI_DeprecatedWidgets.h>

+ Inheritance diagram for MyGUI::VScroll:

Public Types

typedef RTTIBase Base
 
typedef VScroll RTTIBase
 
- Public Types inherited from MyGUI::ScrollBar
typedef RTTIBase Base
 
typedef ScrollBar RTTIBase
 
- Public Types inherited from MyGUI::Widget
typedef RTTIBase Base
 
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
 
 VScroll ()
 
- Public Member Functions inherited from MyGUI::ScrollBar
template<typename Type >
bool isType () const
 
 ScrollBar ()
 
void setVerticalAlignment (bool _value)
 
bool getVerticalAlignment () const
 
void setScrollRange (size_t _value)
 
size_t getScrollRange () const
 
void setScrollPosition (size_t _value)
 
size_t getScrollPosition () const
 
void setScrollPage (size_t _value)
 
size_t getScrollPage () const
 
void setScrollViewPage (size_t _value)
 
size_t getScrollViewPage () const
 
void setScrollWheelPage (size_t _value)
 
size_t getScrollWheelPage () const
 
int getLineSize () const
 
void setTrackSize (int _value)
 
int getTrackSize () const
 
void setMinTrackSize (int _value)
 
int getMinTrackSize () const
 
void setMoveToClick (bool _value)
 
bool getMoveToClick () const
 
virtual void setPosition (const IntPoint &_value)
  More...
 
virtual void setSize (const IntSize &_value)
  More...
 
virtual void setCoord (const IntCoord &_value)
  More...
 
void setPosition (int _left, int _top)
  More...
 
void setSize (int _width, int _height)
  More...
 
void setCoord (int _left, int _top, int _width, int _height)
  More...
 
- Public Member Functions inherited from MyGUI::Widget
template<typename Type >
bool isType () const
 
 Widget ()
 
Widget * createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
 
Widget * createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
 
Widget * createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
 
Widget * createWidgetRealT (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="")
 
Widget * createWidgetT (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="")
 
void setPosition (int _left, int _top)
 
void setSize (int _width, int _height)
 
void setCoord (int _left, int _top, int _width, int _height)
 
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)
 
const std::string & getName () const
 Get name of widget. More...
 
virtual void setVisible (bool _value)
 
bool getVisible () const
 
void setDepth (int _value)
 
int getDepth () const
 
bool getInheritedVisible () const
 
virtual void setAlign (Align _value)
 
Align getAlign () const
 
void setAlpha (float _value)
 
float getAlpha () const
 
void setInheritsAlpha (bool _value)
 
bool getInheritsAlpha () const
 
void setColour (const Colour &_value)
 
bool isRootWidget () const
 
Widget * getParent () const
 
IntSize getParentSize () const
 
EnumeratorWidgetPtr getEnumerator () const
 
size_t getChildCount ()
 
Widget * getChildAt (size_t _index)
 
Widget * findWidget (const std::string &_name)
 
void findWidgets (const std::string &_name, VectorWidgetPtr &_result)
 
virtual void setEnabled (bool _value)
 
void setEnabledSilent (bool _value)
 
bool getEnabled () const
 
bool getInheritedEnabled () const
 
IntCoord getClientCoord ()
 
Widget * getClientWidget ()
 
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 () const
 
void setProperty (const std::string &_key, const std::string &_value)
 
virtual size_t _getItemIndex (Widget *_item)
 
void _forcePick (Widget *_widget)
 
void _initialise (WidgetStyle _style, const IntCoord &_coord, const std::string &_skinName, Widget *_parent, ICroppedRectangle *_croppedParent, const std::string &_name)
 
void _shutdown ()
 
void _destroyChildWidget (Widget *_widget)
 
void _setContainer (Widget *_value)
 
Widget * _getContainer ()
 
void _setAlign (const IntSize &_oldsize, const IntSize &_newSize)
 
bool _checkPoint (int _left, int _top) const
 
Widget * _createSkinWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
 
virtual void _resetContainer (bool _update)
 
bool _setWidgetState (const std::string &_value)
 
void _updateChilds ()
 
- 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
 
 IObject ()
 
virtual ~IObject ()
 
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
 
virtual ~ICroppedRectangle ()
 
ICroppedRectangle * getCroppedParent ()
 
IntPoint getPosition () const
 
IntSize getSize () const
 
const IntCoord & getCoord () const
 
const IntPoint & getAbsolutePosition () const
 
IntRect getAbsoluteRect () const
 
IntCoord getAbsoluteCoord () const
 
int getAbsoluteLeft () const
 
int getAbsoluteTop () 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
 
void _setCroppedParent (ICroppedRectangle *_parent)
 
const IntRect & _getMargin () const
 
int _getMarginLeft () const
 
int _getMarginRight () const
 
int _getMarginTop () const
 
int _getMarginBottom () const
 
- 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) const
 
const MapString & getUserStrings () const
 
bool clearUserString (const std::string &_key)
 
bool isUserString (const std::string &_key) const
 
void clearUserStrings ()
 
void setUserData (Any _data)
 
template<typename ValueType >
ValueType * getUserData (bool _throw=true) const
 
void _setInternalData (Any _data)
 
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true) const
 
- Public Member Functions inherited from MyGUI::WidgetInput
 WidgetInput ()
 
virtual ~WidgetInput ()
 
void setNeedToolTip (bool _value)
 
bool getNeedToolTip () const
 
void setPointer (const std::string &_value)
 
const std::string & getPointer () const
 
void setNeedKeyFocus (bool _value)
 
bool getNeedKeyFocus () const
 
void setNeedMouseFocus (bool _value)
 
bool getNeedMouseFocus () const
 
void setInheritsPick (bool _value)
 
bool getInheritsPick () const
 
void setMaskPick (const std::string &_filename)
 
void setMaskPick (const MaskPickInfo &_info)
 
bool isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const
 
bool getRootMouseFocus () const
 
bool getRootKeyFocus () const
 
void _riseMouseLostFocus (Widget *_new)
 
void _riseMouseSetFocus (Widget *_old)
 
void _riseMouseDrag (int _left, int _top, MouseButton _id)
 
void _riseMouseMove (int _left, int _top)
 
void _riseMouseWheel (int _rel)
 
void _riseMouseButtonPressed (int _left, int _top, MouseButton _id)
 
void _riseMouseButtonReleased (int _left, int _top, MouseButton _id)
 
void _riseMouseButtonClick ()
 
void _riseMouseButtonDoubleClick ()
 
void _riseKeyLostFocus (Widget *_new)
 
void _riseKeySetFocus (Widget *_old)
 
void _riseKeyButtonPressed (KeyCode _key, Char _char)
 
void _riseKeyButtonReleased (KeyCode _key)
 
void _riseMouseChangeRootFocus (bool _focus)
 
void _riseKeyChangeRootFocus (bool _focus)
 
void _setRootMouseFocus (bool _value)
 
void _setRootKeyFocus (bool _value)
 
- Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual ~IDelegateUnlink ()
 
 IDelegateUnlink ()
 
bool compare (IDelegateUnlink *_unlink) const
 
- Public Member Functions inherited from MyGUI::SkinItem
 SkinItem ()
 
ISubWidgetText * getSubWidgetText ()
 
ISubWidgetRect * getSubWidgetMain ()
 
void _setTextureName (const std::string &_texture)
 
const std::string & _getTextureName () const
 
- Public Member Functions inherited from MyGUI::LayerItem
 LayerItem ()
 
virtual ~LayerItem ()
 
ILayer * getLayer () const
 
ILayerNode * getLayerNode () const
 
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::MemberObsolete< Widget >
bool isEnabled ()
 
bool isInheritsAlpha ()
 
bool isNeedKeyFocus ()
 
bool isNeedMouseFocus ()
 
bool isInheritsPick ()
 
bool isVisible ()
 

Static Public Member Functions

static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::ScrollBar
static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::Widget
static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::IObject
static const std::string & getClassTypeName ()
 

Data Fields

EventPair
< EventHandle_WidgetSizeT,
EventHandle_VScrollPtrSizeT > 		eventScrollChangePosition
 
- Data Fields inherited from MyGUI::ScrollBar
EventHandle_ScrollBarPtrSizeT eventScrollChangePosition
 
- Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString eventChangeProperty
 
EventHandle_WidgetVoid eventChangeCoord
 
- Data Fields inherited from MyGUI::WidgetInput
EventHandle_WidgetWidget eventMouseLostFocus
 
EventHandle_WidgetWidget eventMouseSetFocus
 
EventPairAddParameter
< EventHandle_WidgetIntInt,
EventHandle_WidgetIntIntButton > 		eventMouseDrag
 
EventHandle_WidgetIntInt eventMouseMove
 
EventHandle_WidgetInt eventMouseWheel
 
EventHandle_WidgetIntIntButton eventMouseButtonPressed
 
EventHandle_WidgetIntIntButton eventMouseButtonReleased
 
EventHandle_WidgetVoid eventMouseButtonClick
 
EventHandle_WidgetVoid eventMouseButtonDoubleClick
 
EventHandle_WidgetWidget eventKeyLostFocus
 
EventHandle_WidgetWidget eventKeySetFocus
 
EventHandle_WidgetKeyCodeChar eventKeyButtonPressed
 
EventHandle_WidgetKeyCode eventKeyButtonReleased
 
EventHandle_WidgetBool eventRootMouseChangeFocus
 
EventHandle_WidgetBool eventRootKeyChangeFocus
 
EventHandle_WidgetToolTip eventToolTip
 

Additional Inherited Members

- Protected Member Functions inherited from MyGUI::ScrollBar
virtual void initialiseOverride ()
 
virtual void shutdownOverride ()
 
void updateTrack ()
 
void TrackMove (int _left, int _top)
 
virtual void onMouseWheel (int _rel)
 
void notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id)
 
void notifyMouseReleased (Widget *_sender, int _left, int _top, MouseButton _id)
 
void notifyMouseDrag (Widget *_sender, int _left, int _top, MouseButton _id)
 
void notifyMouseWheel (Widget *_sender, int _rel)
 
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)
 
int getTrackPlaceLength () const
 
- Protected Attributes inherited from MyGUI::ScrollBar
Button * mWidgetStart
 
Button * mWidgetEnd
 
Button * mWidgetTrack
 
Widget * mWidgetFirstPart
 
Widget * mWidgetSecondPart
 
IntPoint mPreActionOffset
 
size_t mSkinRangeStart
 
size_t mSkinRangeEnd
 
size_t mScrollRange
 
size_t mScrollPosition
 
size_t mScrollPage
 
size_t mScrollViewPage
 
size_t mScrollWheelPage
 
int mMinTrackSize
 
bool mMoveToClick
 
bool mVerticalAlignment
 

Detailed Description

Definition at line 21 of file MyGUI_DeprecatedWidgets.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::VScroll::Base

Definition at line 24 of file MyGUI_DeprecatedWidgets.h.

typedef VScroll MyGUI::VScroll::RTTIBase

Definition at line 24 of file MyGUI_DeprecatedWidgets.h.

Constructor & Destructor Documentation

MyGUI::VScroll::VScroll ( )
inline

Definition at line 27 of file MyGUI_DeprecatedWidgets.h.

Member Function Documentation

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

Definition at line 24 of file MyGUI_DeprecatedWidgets.h.

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

Get type name as string

Reimplemented from MyGUI::ScrollBar.

Reimplemented in MyGUI::HScroll.

Definition at line 24 of file MyGUI_DeprecatedWidgets.h.

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

Compare with selected type

Reimplemented from MyGUI::ScrollBar.

Reimplemented in MyGUI::HScroll.

Definition at line 24 of file MyGUI_DeprecatedWidgets.h.

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

Compare with selected type

Definition at line 24 of file MyGUI_DeprecatedWidgets.h.

Field Documentation

EventPair<EventHandle_WidgetSizeT, EventHandle_VScrollPtrSizeT> MyGUI::VScroll::eventScrollChangePosition

Event : scroll tracker position changed.
signature : void method(MyGUI::VScroll* _sender, size_t _position)

Parameters
_senderwidget that called this event
_position- new tracker position

Definition at line 38 of file MyGUI_DeprecatedWidgets.h.

The documentation for this class was generated from the following file:
Generated on Wed Aug 20 2014 00:03:35 for MyGUI by   doxygen 1.8.3.1