MGUI::CTRL_SCROLLBAR Class Reference

ScrollBar control. More...

Inheritance diagram for MGUI::CTRL_SCROLLBAR:

Public Types
enum	ORIENTATION { ORIENTATION_Horizontal, ORIENTATION_Vertical }
Public Member Functions
	CTRL_SCROLLBAR ()
virtual	~CTRL_SCROLLBAR ()
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, ORIENTATION orientation)
INT32	GetPosition () const
void	SetDelegateOnChangePosition (DELEGATE_VOID_INT32 delegate)
void	SetDelegateOnDrag (DELEGATE_VOID_INT32 delegate)
void	SetPosition (INT32 position, bool notify=true)
void	SetValues (INT32 position, INT32 minvalue, INT32 maxvalue, INT32 pagesize, INT32 stepincrement=1, INT32 pageincrement=0, bool notify=true)

Detailed Description

ScrollBar control.

Enumerator:

ORIENTATION_Horizontal
ORIENTATION_Vertical

MGUI::CTRL_SCROLLBAR::CTRL_SCROLLBAR ( )

Constructor.

virtual MGUI::CTRL_SCROLLBAR::~CTRL_SCROLLBAR ( ) [virtual]

Destructor.

void MGUI::CTRL_SCROLLBAR::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		ORIENTATION	orientation
	)

Create scrollbar control.

Parameters:

	ParentPane	Parent pane
	orientation	Orientation

INT32 MGUI::CTRL_SCROLLBAR::GetPosition ( ) const

Get slider position.

void MGUI::CTRL_SCROLLBAR::SetDelegateOnChangePosition ( DELEGATE_VOID_INT32 delegate ) [inline]

Set delegate to call after position changed.

void MGUI::CTRL_SCROLLBAR::SetDelegateOnDrag ( DELEGATE_VOID_INT32 delegate ) [inline]

Set delegate to call while user drags slider.

If no delegate is set, position changes will only be reported after pointer button is released.

void MGUI::CTRL_SCROLLBAR::SetPosition	(	INT32	position,
		bool	notify = `true`
	)

Set slider position.

Parameters:

	position	New position
	notify	Notify via "change position" delegate if position changed

void MGUI::CTRL_SCROLLBAR::SetValues	(	INT32	position,
		INT32	minvalue,
		INT32	maxvalue,
		INT32	pagesize,
		INT32	stepincrement = `1`,
		INT32	pageincrement = `0`,
		bool	notify = `true`
	)

Set all values.

Parameters:

	position	New position
	minvalue	Minimum value
	maxvalue	Maximum value
	pagesize	Page size (used to determine slider length)
	stepincrement	Increment for when user clicks on arrows or scrolls with pointer wheel
	pageincrement	Increment when user clicks in "trough", <= 0 use 90% of pagesize
	notify	Notify via "change position" delegate that values are changed

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