MyGUI  3.2.1
Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
MyGUI::ScrollBar Class Reference

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

#include <MyGUI_ScrollBar.h>

+ Inheritance diagram for MyGUI::ScrollBar:

Public Types

typedef RTTIBase Base
typedef ScrollBar 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
 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
void setRepeatEnabled (bool enabled)
bool getRepeatEnabled () const
void setRepeatTriggerTime (float time)
float getRepeatTriggerTime (float time) const
void setRepeatStepTime (float time)
float getRepeatStepTime (float time) const
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)

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventHandle_ScrollBarPtrSizeT eventScrollChangePosition

Protected Member Functions

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

ButtonmWidgetStart
ButtonmWidgetEnd
ButtonmWidgetTrack
WidgetmWidgetFirstPart
WidgetmWidgetSecondPart
IntPoint mPreActionOffset
size_t mSkinRangeStart
size_t mSkinRangeEnd
size_t mScrollRange
size_t mScrollPosition
size_t mScrollPage
size_t mScrollViewPage
size_t mScrollWheelPage
bool mEnableRepeat
float mRepeatTriggerTime
float mRepeatStepTime
int mMinTrackSize
bool mMoveToClick
bool mVerticalAlignment

Detailed Description

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

Definition at line 23 of file MyGUI_ScrollBar.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll, and MyGUI::VScroll.

Definition at line 27 of file MyGUI_ScrollBar.h.

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll, and MyGUI::VScroll.

Definition at line 27 of file MyGUI_ScrollBar.h.


Constructor & Destructor Documentation

Definition at line 18 of file MyGUI_ScrollBar.cpp.


Member Function Documentation

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

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll, and MyGUI::VScroll.

Definition at line 27 of file MyGUI_ScrollBar.h.

Get size in pixels of area where scroll moves

Definition at line 432 of file MyGUI_ScrollBar.cpp.

Get minimal track size

Definition at line 644 of file MyGUI_ScrollBar.cpp.

Get move to click mode flag

Definition at line 654 of file MyGUI_ScrollBar.cpp.

Get whether Repeat mode is enabled

See also:
setRepeatEnabled

Definition at line 415 of file MyGUI_ScrollBar.cpp.

float MyGUI::ScrollBar::getRepeatStepTime ( float  time) const

Get how much time between scrollbar button repeats.

Definition at line 405 of file MyGUI_ScrollBar.cpp.

float MyGUI::ScrollBar::getRepeatTriggerTime ( float  time) const

Get time that buttons need to be pressed down to start repeating.

Definition at line 400 of file MyGUI_ScrollBar.cpp.

Get scroll page

Definition at line 615 of file MyGUI_ScrollBar.cpp.

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

Definition at line 605 of file MyGUI_ScrollBar.cpp.

Get scroll range

Definition at line 600 of file MyGUI_ScrollBar.cpp.

Get scroll view page

Definition at line 625 of file MyGUI_ScrollBar.cpp.

Get scroll view page

Definition at line 634 of file MyGUI_ScrollBar.cpp.

int MyGUI::ScrollBar::getTrackPlaceLength ( ) const [protected]

Definition at line 674 of file MyGUI_ScrollBar.cpp.

Get size of track in pixels

Definition at line 420 of file MyGUI_ScrollBar.cpp.

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

Get type name as string

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll, and MyGUI::VScroll.

Definition at line 27 of file MyGUI_ScrollBar.h.

Get vertical alignment grid mode flag

Definition at line 693 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::initialiseOverride ( ) [protected, virtual]
skin clilds:
Start is child widget with type Button. Кнопка начала диапазона.
skin clilds:
End is child widget with type Button. Кнопка конца диапазона.
skin clilds:
Track is child widget with type Button. Кнопка трекера.
skin clilds:
FirstPart is child widget with type Widget. Виджет первой половины прокрутки от начала до трекера, при нажатии восприницмается как прокрутка страницы.
skin clilds:
SecondPart is child widget with type Widget. Виджет второй половины прокрутки от трекера до конца, при нажатии восприницмается как прокрутка страницы.

Reimplemented from MyGUI::Widget.

Definition at line 40 of file MyGUI_ScrollBar.cpp.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll, and MyGUI::VScroll.

Definition at line 27 of file MyGUI_ScrollBar.h.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::HScroll, and MyGUI::VScroll.

Definition at line 27 of file MyGUI_ScrollBar.h.

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

Definition at line 331 of file MyGUI_ScrollBar.cpp.

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

Definition at line 269 of file MyGUI_ScrollBar.cpp.

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

Definition at line 325 of file MyGUI_ScrollBar.cpp.

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

Definition at line 444 of file MyGUI_ScrollBar.cpp.

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

Reimplemented from MyGUI::WidgetInput.

Definition at line 437 of file MyGUI_ScrollBar.cpp.

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

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 371 of file MyGUI_ScrollBar.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 669 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setMinTrackSize ( int  _value)

Set minimal track size (used for setTrackSize)

Definition at line 639 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setMoveToClick ( bool  _value)

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 649 of file MyGUI_ScrollBar.cpp.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 359 of file MyGUI_ScrollBar.cpp.

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

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 659 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]
Properties:
Range is ScrollBar property with type size_t. Диапазон прокрутки.
Properties:
RangePosition is ScrollBar property with type size_t. Положение прокрутки.
Properties:
Page is ScrollBar property with type size_t. Шаг прокрутки при нажатии на кнопку начала или конца.
Properties:
ViewPage is ScrollBar property with type size_t. Шаг прокрутки при нажатии на одну из частей от кнопки до трекера.
Properties:
WheelPage is ScrollBar property with type size_t. Шаг прокрутки при прокрутке колесиком мыши.
Properties:
MoveToClick is ScrollBar property with type bool. Режим перескакивания бегунка к месту клика.
Properties:
VerticalAlignment is ScrollBar property with type bool. Вертикальное выравнивание.
Properties:
Repeat is ScrollBar property with type bool. Sets whether scrollbar buttons should be triggered repeatedly so long as the mouse button is pressed down.
Properties:
RepeatTriggerTime is ScrollBar property with type float. How long the mouse needs to be pressed on a scrollbar button for repeating to start.

{ScrollBar, RepeatStepTime, float) The time between each repeat step once repeating has started.

Reimplemented from MyGUI::Widget.

Definition at line 549 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setRepeatEnabled ( bool  enabled)

Set whether clicks on scrollbar buttons should be repeated at set intervals as long as the mouse button is pressed down. Enabled (true) by default.

Definition at line 410 of file MyGUI_ScrollBar.cpp.

Set how much time between scrollbar button repeats.

Definition at line 395 of file MyGUI_ScrollBar.cpp.

Set time that buttons need to be pressed down to start repeating.

Definition at line 390 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setScrollPage ( size_t  _value)

Set scroll page

Parameters:
_valueTracker step when buttons pressed

Definition at line 610 of file MyGUI_ScrollBar.cpp.

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

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

Definition at line 347 of file MyGUI_ScrollBar.cpp.

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

Set scroll range

Definition at line 337 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setScrollViewPage ( size_t  _value)

Set scroll view page

Parameters:
_valueTracker step when pressed on scroll line

Definition at line 620 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setScrollWheelPage ( size_t  _value)

Set scroll view page

Parameters:
_valueTracker step when mouse wheel scrolled

Definition at line 630 of file MyGUI_ScrollBar.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 364 of file MyGUI_ScrollBar.cpp.

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

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 664 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setTrackSize ( int  _value)

Set size of track in pixels

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

Definition at line 378 of file MyGUI_ScrollBar.cpp.

Set vertical alignment grid mode

Definition at line 686 of file MyGUI_ScrollBar.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 115 of file MyGUI_ScrollBar.cpp.

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

Definition at line 201 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::updateTrack ( ) [protected]

Definition at line 126 of file MyGUI_ScrollBar.cpp.


Field Documentation

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

Parameters:
_senderwidget that called this event
_position- new tracker position

Reimplemented in MyGUI::VScroll.

Definition at line 130 of file MyGUI_ScrollBar.h.

Definition at line 179 of file MyGUI_ScrollBar.h.

Definition at line 183 of file MyGUI_ScrollBar.h.

Definition at line 184 of file MyGUI_ScrollBar.h.

Definition at line 167 of file MyGUI_ScrollBar.h.

Definition at line 181 of file MyGUI_ScrollBar.h.

Definition at line 180 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mScrollPage [protected]

Definition at line 175 of file MyGUI_ScrollBar.h.

Definition at line 174 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mScrollRange [protected]

Definition at line 173 of file MyGUI_ScrollBar.h.

Definition at line 176 of file MyGUI_ScrollBar.h.

Definition at line 177 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mSkinRangeEnd [protected]

Definition at line 171 of file MyGUI_ScrollBar.h.

Definition at line 170 of file MyGUI_ScrollBar.h.

Definition at line 186 of file MyGUI_ScrollBar.h.

Definition at line 160 of file MyGUI_ScrollBar.h.

Definition at line 163 of file MyGUI_ScrollBar.h.

Definition at line 164 of file MyGUI_ScrollBar.h.

Definition at line 159 of file MyGUI_ScrollBar.h.

Definition at line 161 of file MyGUI_ScrollBar.h.


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