SallyAPI::GUI::CScrollbar Class Reference

Scrollbar. More...

#include <Scrollbar.h>

Inheritance diagram for SallyAPI::GUI::CScrollbar:

List of all members.

Public Member Functions
	CScrollbar (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int height, SCROLLBAR_ALIGNMENT scrollbarAlignment, int controlId=0)
	Constructor.
virtual	~CScrollbar ()
	Destructor.
void	ShowScrollbarIfNotScrollable (bool value)
	Shows the scrollbar if not scrollable.
bool	IsScrollbarVisibleIfNotScrollbable ()
	Query if this object is scrollbar visible if not scrollbable.
void	SetMaxPosition (int position)
	Sets a maximum position.
void	SetPosition (int position)
	Sets a position.
int	GetMaxPosition ()
	Gets the maximum position.
int	GetPosition ()
	Gets the scrolling position. 0 would be the begining, the highest value = positionMax.
virtual void	SendMessageToParent (CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to parent.
virtual void	SendMessageToChilds (CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to childs.
virtual bool	CheckProcessMouseDown (int x, int y)
	Check process mouse down.

---

Detailed Description

Scrollbar.

Author:

Christian Knobloch

Date:

30.04.2010

---

Constructor & Destructor Documentation

CScrollbar::CScrollbar	(	SallyAPI::GUI::CGUIBaseObject *	parent,
		int	x,
		int	y,
		int	width,
		int	height,
		SCROLLBAR_ALIGNMENT	scrollbarAlignment,
		int	controlId = 0
	)

Constructor.

m_eScrollbarAlignment(scrollbarAlignment), m_iPosition(0), m_iPositionMax(0), m_bShowScrollbarIfNotScrollable(true), m_iKnobHeight(CONTROL_HEIGHT)

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	parent	If non-null, the parent.
	x	The x coordinate.
	y	The y coordinate.
	width	The width.
	height	The height.
	scrollbarAlignment	The scrollbar alignment.
	controlId	Identifier for the control.

CScrollbar::~CScrollbar

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

26.04.2010

---

Member Function Documentation

bool CScrollbar::CheckProcessMouseDown	(	int	x,
		int	y
	)		[virtual]

Check process mouse down.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

int SallyAPI::GUI::CScrollbar::GetMaxPosition

(

void

)

Gets the maximum position.

Author:

Christian Knobloch

Date:

27.04.2010

Returns:

The maximum position.

int CScrollbar::GetPosition

(

)

Gets the scrolling position. 0 would be the begining, the highest value = positionMax.

Author:

Christian Knobloch

Date:

26.04.2010

Returns:

The position.

bool CScrollbar::IsScrollbarVisibleIfNotScrollbable

(

void

)

Query if this object is scrollbar visible if not scrollbable.

Author:

Christian Knobloch

Date:

27.04.2010

Returns:

true if scrollbar visible if not scrollbable, false if not.

void CScrollbar::SendMessageToChilds	(	CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

Send message to childs.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Reimplemented from SallyAPI::GUI::CControl.

void CScrollbar::SendMessageToParent	(	CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

Send message to parent.

Author:

Christian Knobloch

Date:

30.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Reimplemented from SallyAPI::GUI::CControl.

void CScrollbar::SetMaxPosition

(

int

position

)

Sets a maximum position.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

position

The position.

void CScrollbar::SetPosition

(

int

position

)

Sets a position.

Author:

Christian Knobloch

Date:

26.04.2010

Parameters:

position

The position.

void CScrollbar::ShowScrollbarIfNotScrollable

(

bool

value

)

Shows the scrollbar if not scrollable.

Author:

Christian Knobloch

Date:

27.04.2010

Parameters:

value

true to value.

---

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

• D:/source/c++/Programme/sally/sally/sallyAPI/Scrollbar.h
• D:/source/c++/Programme/sally/sally/sallyAPI/Scrollbar.cpp