Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

MyGUI::ScrollView Class Reference

#include <MyGUI_ScrollView.h>

Inheritance diagram for MyGUI::ScrollView:

Public Types

typedef RTTIBase Base
typedef ScrollView 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
 ScrollView ()
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 setVisibleVScroll (bool _value)
bool isVisibleVScroll ()
void setVisibleHScroll (bool _value)
bool isVisibleHScroll ()
void setCanvasAlign (Align _value)
Align getCanvasAlign ()
void setCanvasSize (const IntSize &_value)
void setCanvasSize (int _width, int _height)
IntSize getCanvasSize ()
const IntCoordgetClientCoord ()
virtual void setProperty (const std::string &_key, const std::string &_value)
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, WidgetPtr _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 showVScroll (bool _visible)
bool isShowVScroll ()
void showHScroll (bool _visible)
bool isShowHScroll ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Protected Member Functions

virtual ~ScrollView ()
void baseChangeWidgetSkin (ResourceSkin *_info)
virtual WidgetPtr baseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name)
void notifyMouseSetFocus (WidgetPtr _sender, WidgetPtr _old)
void notifyMouseLostFocus (WidgetPtr _sender, WidgetPtr _new)
void notifyMousePressed (WidgetPtr _sender, int _left, int _top, MouseButton _id)
void notifyMouseReleased (WidgetPtr _sender, int _left, int _top, MouseButton _id)
void notifyScrollChangePosition (VScrollPtr _sender, size_t _position)
void notifyMouseWheel (WidgetPtr _sender, int _rel)
virtual void onKeyLostFocus (WidgetPtr _new)
virtual void onKeySetFocus (WidgetPtr _old)
void updateScrollViewState ()
void updateView ()

Protected Attributes

bool mIsFocus
bool mIsPressed
WidgetPtr mScrollClient
Align mContentAlign

Detailed Description

Definition at line 33 of file MyGUI_ScrollView.h.


Member Typedef Documentation

Definition at line 37 of file MyGUI_ScrollView.h.

Definition at line 37 of file MyGUI_ScrollView.h.


Constructor & Destructor Documentation

MyGUI::ScrollView::ScrollView (  ) 

Definition at line 36 of file MyGUI_ScrollView.cpp.

MyGUI::ScrollView::~ScrollView (  )  [protected, virtual]

Definition at line 53 of file MyGUI_ScrollView.cpp.


Member Function Documentation

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

Definition at line 46 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::baseChangeWidgetSkin ( ResourceSkin _info  )  [protected]

Definition at line 58 of file MyGUI_ScrollView.cpp.

WidgetPtr MyGUI::ScrollView::baseCreateWidget ( WidgetStyle  _style,
const std::string &  _type,
const std::string &  _skin,
const IntCoord _coord,
Align  _align,
const std::string &  _layer,
const std::string &  _name 
) [protected, virtual]

Definition at line 241 of file MyGUI_ScrollView.cpp.

Align MyGUI::ScrollView::getCanvasAlign (  )  [inline]

Get canvas align

Definition at line 69 of file MyGUI_ScrollView.h.

IntSize MyGUI::ScrollView::getCanvasSize (  )  [inline]

Get canvas size

Definition at line 76 of file MyGUI_ScrollView.h.

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

Definition at line 37 of file MyGUI_ScrollView.h.

const IntCoord& MyGUI::ScrollView::getClientCoord (  )  [inline]

Get rect where child widgets placed

Definition at line 79 of file MyGUI_ScrollView.h.

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

Get type name as string

Definition at line 37 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isShowHScroll (  )  [inline]
Deprecated:
"use : bool ScrollView::isVisibleHScroll()"

Definition at line 102 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isShowVScroll (  )  [inline]
Deprecated:
"use : bool ScrollView::isVisibleVScroll()"

Definition at line 98 of file MyGUI_ScrollView.h.

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

Compare with selected type

Definition at line 37 of file MyGUI_ScrollView.h.

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

Compare with selected type

Definition at line 37 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isVisibleHScroll (  )  [inline]

Get Show HScroll flag

Definition at line 64 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isVisibleVScroll (  )  [inline]

Get Show VScroll flag

Definition at line 59 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::notifyMouseLostFocus ( WidgetPtr  _sender,
WidgetPtr  _new 
) [protected]

Definition at line 121 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyMousePressed ( WidgetPtr  _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]
void MyGUI::ScrollView::notifyMouseReleased ( WidgetPtr  _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]
void MyGUI::ScrollView::notifyMouseSetFocus ( WidgetPtr  _sender,
WidgetPtr  _old 
) [protected]

Definition at line 114 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyMouseWheel ( WidgetPtr  _sender,
int  _rel 
) [protected]

Definition at line 197 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyScrollChangePosition ( VScrollPtr  _sender,
size_t  _position 
) [protected]

Definition at line 181 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::onKeyLostFocus ( WidgetPtr  _new  )  [protected, virtual]

Definition at line 139 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::onKeySetFocus ( WidgetPtr  _old  )  [protected, virtual]

Definition at line 128 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCanvasAlign ( Align  _value  ) 

Set canvas align

Definition at line 294 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCanvasSize ( int  _width,
int  _height 
) [inline]

Set canvas size

Definition at line 74 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setCanvasSize ( const IntSize _value  ) 

Set canvas size

Definition at line 300 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCoord ( int  _left,
int  _top,
int  _width,
int  _height 
) [inline]
void MyGUI::ScrollView::setCoord ( const IntCoord _value  )  [virtual]

Set widget position and size

Definition at line 174 of file MyGUI_ScrollView.cpp.

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

Set widget position (position of left top corner)

Definition at line 162 of file MyGUI_ScrollView.cpp.

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

Definition at line 91 of file MyGUI_ScrollView.h.

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

Definition at line 93 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setPosition ( int  _left,
int  _top 
) [inline]
void MyGUI::ScrollView::setProperty ( const std::string &  _key,
const std::string &  _value 
) [virtual]

Definition at line 305 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setSize ( int  _width,
int  _height 
) [inline]
void MyGUI::ScrollView::setSize ( const IntSize _value  )  [virtual]

Set widget size

Definition at line 167 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setVisibleHScroll ( bool  _value  ) 

Show HScroll when text size larger than Edit

Definition at line 288 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setVisibleVScroll ( bool  _value  ) 

Show VScroll when text size larger than Edit

Definition at line 282 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::showHScroll ( bool  _visible  )  [inline]
Deprecated:
"use : void ScrollView::setVisibleHScroll(bool _visible)"

Definition at line 100 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::showVScroll ( bool  _visible  )  [inline]
Deprecated:
"use : void ScrollView::setVisibleVScroll(bool _visible)"

Definition at line 96 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::updateScrollViewState (  )  [protected]

Definition at line 150 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::updateView (  )  [protected]

Definition at line 276 of file MyGUI_ScrollView.cpp.


Field Documentation

Definition at line 150 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::mIsFocus [protected]

Definition at line 146 of file MyGUI_ScrollView.h.

Definition at line 147 of file MyGUI_ScrollView.h.

Definition at line 149 of file MyGUI_ScrollView.h.


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