SkyGI::ScrollBar Class Reference

Inheritance diagram for SkyGI::ScrollBar:[legend]Collaboration diagram for SkyGI::ScrollBar:[legend]List of all members.

Public Member Functions
	ScrollBar (Window *pParent, const Rect rFrame, unsigned int nWindowLayoutFlags, bool bHorizontal)
	~ScrollBar ()
void	Paint (const Rect &rDirty)
Point	GetSizeHint (enumSizeHint nSizeHint)
bool	IsVertical ()
bool	IsHorizontal ()
Rect	GetIndicatorRect ()
void	SetMinMax (int iMin, int iMax)
void	SetStep (int iSingle, int iPage)
void	MouseDown (const InputEvent &nInputEvent)
void	MouseUp (const InputEvent &nInputEvent)
void	MouseMove (const InputEvent &nInputEvent)
void	MouseLeave (const InputEvent &nInputEvent)
void	OnTimer (int iTimerID, void *vpCookie)
void	SetValue (int iValue)
int	GetValue ()
void	Sized (const Point &cPos)
Public Attributes
signal2< int, int >	Changed

---

Constructor & Destructor Documentation

ScrollBar::ScrollBar	(	Window *	pParent,
		const Rect	rFrame,
		unsigned int	nWindowLayoutFlags,
		bool	bHorizontal
	)

ScrollBar::~ScrollBar

(

)

---

Member Function Documentation

void ScrollBar::Paint

(

const Rect &

rDirty

)

[virtual]

Paint window content

Description:

This function gets called whenever an area of the window has to be redrawn. Usually you should only draw from inside the Paint function. If you need to redraw a window (when lets say some content must be updated), simply call Invalidate() which will then (asynchronly) call this paint function.

Usually you should draw the background using Window::DrawBackground(rDirty) and the border with DrawBorder(rRect). This way the user has full control over the appearance of your window, meaning he can change the background and border style.
The window content area itself is defined by the border margin and the window margin. Every window may define a margin. If you draw content into this window always make sure to not draw into the margin area. Additionally, the border has a margin too. As the user has full control to select any border for your window make sure to user the current borders margin when drawing window content. the dra Window::Paint() just redraws the background using DrawBackground. Overload this member function to add custom dawing code

Overload this member function to add custom dawing code

Parameters:

rDirty

- Dirty rectangular region which has to be redrawn. Prior entering this function the painters clip region is automatically set to this dirty region.

See also:

DrawBorder, DrawBackground, Border, GetBorder, GetBorder::Margin, GetMargin

Reimplemented from SkyGI::Window.

Point ScrollBar::GetSizeHint

(

enumSizeHint

nSizeHint

)

[virtual]

Get size hint

Description:

Overload this member function for derived classes to inform the GUI about size hints for your widget.

SIZE_HINT_PREFERRED

Return the preferred size of the widget (may depend on the actual content)

SIZE_HINT_MINIMUM

Return the minimum size the widget needs to display a proper content

Note:

If you want to get the minimum or preferred size of a window always use GetMinimumSize or GetPreferredSize. Don't call GetSizeHint directly

See also:

GetPreferredSize, GetMinimumSize, SetMinimumSize

Reimplemented from SkyGI::Window.

bool ScrollBar::IsVertical

(

)

bool ScrollBar::IsHorizontal

(

)

Rect ScrollBar::GetIndicatorRect

(

)

void ScrollBar::SetMinMax	(	int	iMin,
		int	iMax
	)

void ScrollBar::SetStep	(	int	iSingle,
		int	iPage
	)

void ScrollBar::MouseDown

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse pressed

Description:

This function gets called when a mouse press occured inside this window.

Overload this member function to react on mouse presses.

Parameters:

	nButton	- MouseButton which was pressed
	nMouseButtonMask	- Mask showing which mouse buttons were pressed when the mouse press occured
	nInputEvent	- INPUT_EVENT_MOUSE_PRESS for a single and INPUTE_EVENT_MOUSE_DOUBLECLICK for a doubleclick

Reimplemented from SkyGI::Window.

void ScrollBar::MouseUp

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse release

Description:

This function gets called when a mouse release occured inside this window.

Overload this member function to react on mouse releases.

Parameters:

	nButton	- MouseButton which was released
	nMouseButtonMask	- Mask showing which additional mouse buttons were pressed when the mouse release occured
	nInputEvent	- INPUT_EVENT_MOUSE_RELEASE

Reimplemented from SkyGI::Window.

void ScrollBar::MouseMove

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse move

Description:

This function gets called when the mouse cursor was moved inside the window. Mouse move events are only generated after a call to EnableMouseMoveEvents(). Use DisableMouseMoveEvents() to disable further generation of mouse move events.

Overload this member function to react on mouse move events.

Parameters:

	pNewPosition	- Current mouse cursor position
	pOldPosition	- Old mouse cursor position
	nMouseButtonMask	- Mask showing which mouse buttons were pressed when the mouse move occured

Reimplemented from SkyGI::Window.

void ScrollBar::MouseLeave

(

const InputEvent &

nInputEvent

)

[virtual]

Mouse leave

Description:

This function gets called when the mouse leaves the window.

Overload this member function to react on mouse leave events.

Parameters:

	pPosLeave	- Position the mouse cursor leaved the window at
	nMouseButtonMask	- Mask showing which mouse buttons were pressed when the mouse leave occured

Reimplemented from SkyGI::Window.

void ScrollBar::OnTimer	(	int	iTimerID,
		void *	vpCookie
	)			[virtual]

Reimplemented from SkyGI::Window.

void ScrollBar::SetValue

(

int

iValue

)

int ScrollBar::GetValue

(

)

void ScrollBar::Sized

(

const Point &

cPos

)

[virtual]

Called when window is resized

Description:

Overload this function to get notified when the window is resized

Note:

Call this function from the overloaded function to perform automatic window layout on child windows

Parameters:

pDelta

- Size the window was resized

See also:

MoveTo, MoveBy, SetRect, Moved, Layout

Reimplemented from SkyGI::Window.

---

Member Data Documentation

signal2<int, int> SkyGI::ScrollBar::Changed

Emitted when scoll position has changed

Parameters:

	iValue	New scroll value
	iOldValue	Old scroll value

---