#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
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)
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
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
int	mMinTrackSize
bool	mMoveToClick
bool	mVerticalAlignment

Detailed Description

Definition at line 33 of file MyGUI_ScrollBar.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::ScrollBar::Base

Reimplemented from MyGUI::Widget.

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

Definition at line 37 of file MyGUI_ScrollBar.h.

typedef ScrollBar MyGUI::ScrollBar::RTTIBase

Reimplemented from MyGUI::Widget.

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

Definition at line 37 of file MyGUI_ScrollBar.h.

Constructor & Destructor Documentation

MyGUI::ScrollBar::ScrollBar ( )

Definition at line 34 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 37 of file MyGUI_ScrollBar.h.

int MyGUI::ScrollBar::getLineSize ( ) const

Get size in pixels of area where scroll moves

Definition at line 439 of file MyGUI_ScrollBar.cpp.

int MyGUI::ScrollBar::getMinTrackSize ( ) const

Get minimal track size

Definition at line 533 of file MyGUI_ScrollBar.cpp.

bool MyGUI::ScrollBar::getMoveToClick ( ) const

Get move to click mode flag

Definition at line 543 of file MyGUI_ScrollBar.cpp.

size_t MyGUI::ScrollBar::getScrollPage ( ) const

Get scroll page

Definition at line 513 of file MyGUI_ScrollBar.cpp.

size_t MyGUI::ScrollBar::getScrollPosition ( ) const

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

Definition at line 503 of file MyGUI_ScrollBar.cpp.

size_t MyGUI::ScrollBar::getScrollRange ( ) const

Get scroll range

Definition at line 498 of file MyGUI_ScrollBar.cpp.

size_t MyGUI::ScrollBar::getScrollViewPage ( ) const

Get scroll view page

Definition at line 523 of file MyGUI_ScrollBar.cpp.

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

Definition at line 563 of file MyGUI_ScrollBar.cpp.

int MyGUI::ScrollBar::getTrackSize ( ) const

Get size of track in pixels

Definition at line 427 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 37 of file MyGUI_ScrollBar.h.

bool MyGUI::ScrollBar::getVerticalAlignment ( ) const

Get vertical alignment grid mode flag

Definition at line 582 of file MyGUI_ScrollBar.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 52 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 37 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 37 of file MyGUI_ScrollBar.h.

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

Definition at line 367 of file MyGUI_ScrollBar.cpp.

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

Definition at line 267 of file MyGUI_ScrollBar.cpp.

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

Definition at line 362 of file MyGUI_ScrollBar.cpp.

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

Definition at line 451 of file MyGUI_ScrollBar.cpp.

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

Reimplemented from MyGUI::WidgetInput.

Definition at line 444 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 407 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 558 of file MyGUI_ScrollBar.cpp.

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

Set minimal track size (used for setTrackSize)

Definition at line 528 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 538 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 395 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 548 of file MyGUI_ScrollBar.cpp.

void MyGUI::ScrollBar::setPropertyOverride	(	const std::string &	_key,
		const std::string &	_value
	)		`[protected, virtual]`

Reimplemented from MyGUI::Widget.

Definition at line 476 of file MyGUI_ScrollBar.cpp.

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

Set scroll page

Parameters:

_value Tracker step when buttons pressed

Definition at line 508 of file MyGUI_ScrollBar.cpp.

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

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

Definition at line 383 of file MyGUI_ScrollBar.cpp.

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

Set scroll range

Definition at line 373 of file MyGUI_ScrollBar.cpp.

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

Set scroll view page

Parameters:

_value Tracker step when pressed on scroll line

Definition at line 518 of file MyGUI_ScrollBar.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 400 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 553 of file MyGUI_ScrollBar.cpp.

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

Set size of track in pixels

Parameters:

_value in pixels, if less than MinTrackSize, MinTrackSize used

Definition at line 414 of file MyGUI_ScrollBar.cpp.

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

Set vertical alignment grid mode

Definition at line 575 of file MyGUI_ScrollBar.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 113 of file MyGUI_ScrollBar.cpp.

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

Definition at line 199 of file MyGUI_ScrollBar.cpp.

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

Definition at line 124 of file MyGUI_ScrollBar.cpp.

Field Documentation

EventHandle_ScrollBarPtrSizeT MyGUI::ScrollBar::eventScrollChangePosition

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

Parameters:

_sender	widget that called this event
_position	- new tracker position

Reimplemented in MyGUI::VScroll.

Definition at line 115 of file MyGUI_ScrollBar.h.

int MyGUI::ScrollBar::mMinTrackSize [protected]

Definition at line 156 of file MyGUI_ScrollBar.h.

bool MyGUI::ScrollBar::mMoveToClick [protected]

Definition at line 157 of file MyGUI_ScrollBar.h.

IntPoint MyGUI::ScrollBar::mPreActionOffset [protected]

Definition at line 145 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mScrollPage [protected]

Definition at line 153 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mScrollPosition [protected]

Definition at line 152 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mScrollRange [protected]

Definition at line 151 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mScrollViewPage [protected]

Definition at line 154 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mSkinRangeEnd [protected]

Definition at line 149 of file MyGUI_ScrollBar.h.

size_t MyGUI::ScrollBar::mSkinRangeStart [protected]

Definition at line 148 of file MyGUI_ScrollBar.h.

bool MyGUI::ScrollBar::mVerticalAlignment [protected]

Definition at line 159 of file MyGUI_ScrollBar.h.

Button* MyGUI::ScrollBar::mWidgetEnd [protected]

Definition at line 138 of file MyGUI_ScrollBar.h.

Widget* MyGUI::ScrollBar::mWidgetFirstPart [protected]

Definition at line 141 of file MyGUI_ScrollBar.h.

Widget* MyGUI::ScrollBar::mWidgetSecondPart [protected]

Definition at line 142 of file MyGUI_ScrollBar.h.

Button* MyGUI::ScrollBar::mWidgetStart [protected]

Definition at line 137 of file MyGUI_ScrollBar.h.

Button* MyGUI::ScrollBar::mWidgetTrack [protected]

Definition at line 139 of file MyGUI_ScrollBar.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation