MyGUI  3.2.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
MyGUI::ScrollView Class Reference

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

#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 () const
void setVisibleHScroll (bool _value)
bool isVisibleHScroll () const
void setCanvasAlign (Align _value)
Align getCanvasAlign () const
void setCanvasSize (const IntSize &_value)
void setCanvasSize (int _width, int _height)
IntSize getCanvasSize ()
IntCoord getViewCoord () const
void setViewOffset (const IntPoint &_value)
IntPoint getViewOffset () const

Static Public Member Functions

static const std::string & getClassTypeName ()

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
void notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id)
void notifyMouseReleased (Widget *_sender, int _left, int _top, MouseButton _id)
void notifyScrollChangePosition (ScrollBar *_sender, size_t _position)
void notifyMouseWheel (Widget *_sender, int _rel)
void updateView ()
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)
ScrollBargetVScroll ()

Protected Attributes

Align mContentAlign
WidgetmRealClient

Detailed Description

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

Definition at line 20 of file MyGUI_ScrollView.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.


Constructor & Destructor Documentation

Definition at line 19 of file MyGUI_ScrollView.cpp.


Member Function Documentation

Get canvas align

Definition at line 278 of file MyGUI_ScrollView.cpp.

Get canvas size

Definition at line 221 of file MyGUI_ScrollView.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

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

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

Get view area coordinates.

Definition at line 336 of file MyGUI_ScrollView.cpp.

Get view area offset.

Definition at line 331 of file MyGUI_ScrollView.cpp.

Definition at line 341 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::initialiseOverride ( ) [protected, virtual]
skin clilds:
Client is child widget with type Widget. Клиентская зона.
skin clilds:
VScroll is child widget with type ScrollBar. Вертикальная полоса прокрутки.
skin clilds:
HScroll is child widget with type ScrollBar. Горизонтальная полоса прокрутки.

Reimplemented from MyGUI::Widget.

Definition at line 26 of file MyGUI_ScrollView.cpp.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

Get Show HScroll flag

Definition at line 273 of file MyGUI_ScrollView.cpp.

Get Show VScroll flag

Definition at line 268 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyMousePressed ( Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]
void MyGUI::ScrollView::notifyMouseReleased ( Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]
void MyGUI::ScrollView::notifyMouseWheel ( Widget _sender,
int  _rel 
) [protected]

Definition at line 112 of file MyGUI_ScrollView.cpp.

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

Definition at line 93 of file MyGUI_ScrollView.cpp.

Set canvas align

Definition at line 208 of file MyGUI_ScrollView.cpp.

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

Set canvas size

Definition at line 214 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCanvasSize ( int  _width,
int  _height 
)

Set canvas size

Definition at line 283 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCoord ( const IntCoord _value) [virtual]

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 86 of file MyGUI_ScrollView.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 263 of file MyGUI_ScrollView.cpp.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 74 of file MyGUI_ScrollView.cpp.

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

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 253 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]
Properties:
VisibleVScroll is ScrollView property with type bool. Видимость вертикальной полосы прокрутки.
Properties:
VisibleHScroll is ScrollView property with type bool. Видимость горизонтальной полосы прокрутки.
Properties:
CanvasAlign is ScrollView property with type Align. Выравнивание содержимого.
Properties:
CanvasSize is ScrollView property with type int int. Размер содержимого.

Reimplemented from MyGUI::Widget.

Definition at line 226 of file MyGUI_ScrollView.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 79 of file MyGUI_ScrollView.cpp.

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

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 258 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setViewOffset ( const IntPoint _value)

Set view area offset.

Definition at line 293 of file MyGUI_ScrollView.cpp.

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

Show HScroll when content size larger than view

Definition at line 202 of file MyGUI_ScrollView.cpp.

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

Show VScroll when content size larger than view

Definition at line 196 of file MyGUI_ScrollView.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 64 of file MyGUI_ScrollView.cpp.

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

Definition at line 190 of file MyGUI_ScrollView.cpp.


Field Documentation

Definition at line 105 of file MyGUI_ScrollView.h.

Definition at line 106 of file MyGUI_ScrollView.h.


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