MyGUI 3.0.1

MyGUI::VScroll Class Reference

#include <MyGUI_VScroll.h>

Inheritance diagram for MyGUI::VScroll:

Public Types

typedef RTTIBase Base
typedef VScroll 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 ()
void setScrollRange (size_t _value)
size_t getScrollRange ()
void setScrollPosition (size_t _value)
size_t getScrollPosition ()
void setScrollPage (size_t _value)
size_t getScrollPage ()
void setScrollViewPage (size_t _value)
size_t getScrollViewPage ()
virtual int getLineSize ()
virtual void setTrackSize (int _value)
virtual int getTrackSize ()
void setMinTrackSize (int _value)
int getMinTrackSize ()
void setMoveToClick (bool _value)
bool getMoveToClick ()
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)
virtual void setProperty (const std::string &_key, const std::string &_value)
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
void setPosition (const IntCoord &_coord)
void setPosition (int _left, int _top, int _width, int _height)

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventPair
< EventHandle_WidgetSizeT,
EventHandle_VScrollPtrSizeT
eventScrollChangePosition

Protected Member Functions

virtual ~VScroll ()
void baseChangeWidgetSkin (ResourceSkin *_info)
virtual void updateTrack ()
virtual 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)
void notifyMouseWheel (Widget *_sender, int _rel)

Protected Attributes

ButtonmWidgetStart
ButtonmWidgetEnd
ButtonmWidgetTrack
ButtonmWidgetFirstPart
ButtonmWidgetSecondPart
IntPoint mPreActionOffset
size_t mSkinRangeStart
size_t mSkinRangeEnd
size_t mScrollRange
size_t mScrollPosition
size_t mScrollPage
size_t mScrollViewPage
int mMinTrackSize
bool mMoveToClick

Detailed Description

Definition at line 35 of file MyGUI_VScroll.h.


Member Typedef Documentation

Reimplemented in MyGUI::HScroll.

Definition at line 38 of file MyGUI_VScroll.h.

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 38 of file MyGUI_VScroll.h.


Constructor & Destructor Documentation

MyGUI::VScroll::VScroll ( )

Definition at line 34 of file MyGUI_VScroll.cpp.

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

Definition at line 58 of file MyGUI_VScroll.cpp.


Member Function Documentation

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

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 51 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::baseChangeWidgetSkin ( ResourceSkin _info) [protected, virtual]

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 63 of file MyGUI_VScroll.cpp.

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

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 38 of file MyGUI_VScroll.h.

int MyGUI::VScroll::getLineSize ( ) [virtual]

Get size in pixels of area where scroll moves

Reimplemented in MyGUI::HScroll.

Definition at line 356 of file MyGUI_VScroll.cpp.

int MyGUI::VScroll::getMinTrackSize ( ) [inline]

Get minimal track size

Definition at line 80 of file MyGUI_VScroll.h.

bool MyGUI::VScroll::getMoveToClick ( ) [inline]

Get move to click mode flag

Definition at line 88 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::getScrollPage ( ) [inline]

Get scroll page

Definition at line 58 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::getScrollPosition ( ) [inline]

Get scroll position (value from 0 to range - 1)

Definition at line 51 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::getScrollRange ( ) [inline]

Get scroll range

Definition at line 46 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::getScrollViewPage ( ) [inline]

Get scroll view page

Definition at line 65 of file MyGUI_VScroll.h.

int MyGUI::VScroll::getTrackSize ( ) [virtual]

Get size of track in pixels

Reimplemented in MyGUI::HScroll.

Definition at line 351 of file MyGUI_VScroll.cpp.

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

Get type name as string

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 38 of file MyGUI_VScroll.h.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 38 of file MyGUI_VScroll.h.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll.

Definition at line 38 of file MyGUI_VScroll.h.

void MyGUI::VScroll::notifyMouseDrag ( Widget _sender,
int  _left,
int  _top 
) [protected]

Definition at line 304 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::notifyMousePressed ( Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]

Definition at line 221 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::notifyMouseReleased ( Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]

Definition at line 299 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::notifyMouseWheel ( Widget _sender,
int  _rel 
) [protected]

Definition at line 368 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::onMouseWheel ( int  _rel) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 361 of file MyGUI_VScroll.cpp.

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

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 337 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::setCoord ( int  _left,
int  _top,
int  _width,
int  _height 
) [inline]

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 102 of file MyGUI_VScroll.h.

void MyGUI::VScroll::setMinTrackSize ( int  _value) [inline]

Set minimal track size (used for setTrackSize)

Definition at line 78 of file MyGUI_VScroll.h.

void MyGUI::VScroll::setMoveToClick ( bool  _value) [inline]

Enable or disable move to click mode.
Move to click mode: Tracker moves to cursor when pressed on scroll line.
Disabled (false) by default.

Definition at line 86 of file MyGUI_VScroll.h.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 325 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::setPosition ( int  _left,
int  _top 
) [inline]

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 98 of file MyGUI_VScroll.h.

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

Reimplemented from MyGUI::Widget.

Definition at line 123 of file MyGUI_VScroll.h.

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

Reimplemented from MyGUI::Widget.

Definition at line 125 of file MyGUI_VScroll.h.

void MyGUI::VScroll::setProperty ( const std::string &  _key,
const std::string &  _value 
) [virtual]

Set any widget property

Parameters:
_keyProperty name (for example Widget_Alpha or Edit_MultiLine)
_valueValue converted to string

Reimplemented from MyGUI::Widget.

Definition at line 388 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::setScrollPage ( size_t  _value) [inline]

Set scroll page

Parameters:
_pageTracker step when buttons pressed

Definition at line 56 of file MyGUI_VScroll.h.

void MyGUI::VScroll::setScrollPosition ( size_t  _value)

Set scroll position (value from 0 to range - 1)

Definition at line 317 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::setScrollRange ( size_t  _value)

Set scroll range

Definition at line 309 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::setScrollViewPage ( size_t  _value) [inline]

Set scroll view page

Parameters:
_viewPageTracker step when pressed on scroll line

Definition at line 63 of file MyGUI_VScroll.h.

void MyGUI::VScroll::setSize ( int  _width,
int  _height 
) [inline]

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 100 of file MyGUI_VScroll.h.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 330 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::setTrackSize ( int  _value) [virtual]

Set size of track in pixels

Parameters:
_valuein pixels, if less than MinTrackSize, MinTrackSize used

Reimplemented in MyGUI::HScroll.

Definition at line 344 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::TrackMove ( int  _left,
int  _top 
) [protected, virtual]

Definition at line 192 of file MyGUI_VScroll.cpp.

void MyGUI::VScroll::updateTrack ( ) [protected, virtual]

Definition at line 152 of file MyGUI_VScroll.cpp.


Field Documentation

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 113 of file MyGUI_VScroll.h.

Definition at line 169 of file MyGUI_VScroll.h.

bool MyGUI::VScroll::mMoveToClick [protected]

Definition at line 170 of file MyGUI_VScroll.h.

Definition at line 158 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::mScrollPage [protected]

Definition at line 166 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::mScrollPosition [protected]

Definition at line 165 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::mScrollRange [protected]

Definition at line 164 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::mScrollViewPage [protected]

Definition at line 167 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::mSkinRangeEnd [protected]

Definition at line 162 of file MyGUI_VScroll.h.

size_t MyGUI::VScroll::mSkinRangeStart [protected]

Definition at line 161 of file MyGUI_VScroll.h.

Definition at line 151 of file MyGUI_VScroll.h.

Definition at line 154 of file MyGUI_VScroll.h.

Definition at line 155 of file MyGUI_VScroll.h.

Definition at line 150 of file MyGUI_VScroll.h.

Definition at line 152 of file MyGUI_VScroll.h.


The documentation for this class was generated from the following files:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines