A simple scroll bar widget. More...

#include <pawscrollbar.h>

Public Member Functions
virtual void	Draw ()
	Draws the widget and all of it's children.
virtual void	EnableValueLimit (bool limited)
	Sets if the constraint of current scrollbar value should be used.
virtual float	GetCurrentValue ()
	Get the current value of the scroll bar.
virtual float	GetMaxValue ()
virtual float	GetMinValue ()
virtual float	GetTickValue ()
	Returns the tick value of this scroll bar.
virtual bool	OnButtonPressed (int button, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed.
virtual bool	OnButtonReleased (int button, int keyModifier, pawsWidget *widget)
	Called whenever a button is released.
virtual bool	OnGainFocus (bool=true)
	Changes hasFocus to TRUE and reports status to parent.
virtual bool	OnMouseDown (int button, int modifiers, int x, int y)
	Manage mouse down event to test for and apply window changes.
virtual bool	OnMouseExit ()
	Called whenever the mouse leaves this widget.
virtual bool	OnMouseUp (int button, int modifiers, int x, int y)
	Manage mouse up event.
virtual void	OnResize ()
	Sets the new position of the close button.
virtual void	OnUpdateData (const char *dataname, PAWSData &data)
	pawsScrollBar (const pawsScrollBar &origin)
	pawsScrollBar ()
virtual bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
bool	ScrollDown ()
	Scrolls one step down.
bool	ScrollUp ()
	Scrolls one step up.
virtual void	SetCurrentValue (float value, bool triggerEvent=true, bool publish=true)
	Set the current value that this scroll bar should have.
virtual void	SetHorizontal (bool value)
virtual void	SetMaxValue (float value)
	Set the max value that this scroll bar should have.
virtual void	SetMinValue (float value)
	Set the min value that this scroll bar should have.
virtual void	SetReversed (bool reversed)
	Sets if scrollbar should return reversed scroll value: left/top=maxValue, right/bottom=minValue.
virtual void	SetTickValue (float tick)
	Set the amount that this scroll bar should change by.
virtual bool	Setup (iDocumentNode *node)
	Setup this widget.
virtual	~pawsScrollBar ()
Protected Member Functions
int	GetScrollBarSize ()
int	GetThumbScaleLength ()
void	LimitCurrentValue ()
	Adjusts currentValue so that 0<=currentValue<=maxValue.
void	MoveThumbToMouse ()
	Sets position of thumb on screen and currentValue according to mouse position.
void	SetButtonLayout ()
	Sets positions and sizes of up and down buttons.
void	SetThumbLayout ()
	Sets position and size of thumb on screen according to currentValue.
void	SetThumbVisibility ()
Protected Attributes
csRef< iVirtualClock >	clock
float	currentValue
pawsButton *	downButton
csString	downGrey
int	downHeight
int	downOffsetx
int	downOffsety
csString	downPressed
csString	downUnpressed
int	downWidth
bool	horizontal
int	lastButton
int	lastModifiers
pawsWidget *	lastWidget
bool	limited
float	maxValue
float	minValue
bool	mouseDown
bool	mouseIsDraggingThumb
bool	reversed
csTicks	scrollTicks
	Keep track of ticks for scrolling.
pawsWidget *	thumb
int	thumbDragPoint
csString	thumbMoving
csString	thumbStopped
float	tickValue
	This is how much value should change on a scroll.
pawsButton *	upButton
csString	upGrey
int	upHeight
int	upOffsetx
int	upOffsety
csString	upPressed
csString	upUnpressed
int	upWidth

Detailed Description

A simple scroll bar widget.

Definition at line 64 of file pawscrollbar.h.

Constructor & Destructor Documentation

pawsScrollBar::pawsScrollBar ( )

pawsScrollBar::pawsScrollBar ( const pawsScrollBar & origin )

virtual pawsScrollBar::~pawsScrollBar ( ) [virtual]

Member Function Documentation

virtual void pawsScrollBar::Draw ( ) [virtual]

Draws the widget and all of it's children.

Remarks:: Uses clipping rect of it's parent to define drawing area. If the drawing area defined is empty it returns.

Reimplemented from pawsWidget.

virtual void pawsScrollBar::EnableValueLimit ( bool limited ) [virtual]

Sets if the constraint of current scrollbar value should be used.

Parameters:

limited Should the value be limited ?

virtual float pawsScrollBar::GetCurrentValue ( ) [virtual]

Get the current value of the scroll bar.

Returns:: The current value.

virtual float pawsScrollBar::GetMaxValue ( ) [inline, virtual]

Definition at line 90 of file pawscrollbar.h.

virtual float pawsScrollBar::GetMinValue ( ) [inline, virtual]

Definition at line 99 of file pawscrollbar.h.

int pawsScrollBar::GetScrollBarSize ( ) [protected]

int pawsScrollBar::GetThumbScaleLength ( ) [protected]

virtual float pawsScrollBar::GetTickValue ( ) [inline, virtual]

Returns the tick value of this scroll bar.

Returns:: the tick value of this scroll bar.

Definition at line 132 of file pawscrollbar.h.

void pawsScrollBar::LimitCurrentValue ( ) [protected]

Adjusts currentValue so that 0<=currentValue<=maxValue.

void pawsScrollBar::MoveThumbToMouse ( ) [protected]

Sets position of thumb on screen and currentValue according to mouse position.

virtual bool pawsScrollBar::OnButtonPressed	(	int	button,
		int	keyModifier,
		pawsWidget *	widget
	)		`[virtual]`

Called whenever a button is pressed.

Parameters:

button	The button pressed.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns:: bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool pawsScrollBar::OnButtonReleased	(	int	button,
		int	keyModifier,
		pawsWidget *	widget
	)		`[virtual]`

Called whenever a button is released.

Parameters:

button	The button released.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns:: bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool pawsScrollBar::OnGainFocus ( bool = true ) [inline, virtual]

Changes hasFocus to TRUE and reports status to parent.

Returns:: bool

Remarks:: Acts recursively on it's parents. If the widget cannot be focused, this function needs be overridden.

Reimplemented from pawsWidget.

Definition at line 150 of file pawscrollbar.h.

virtual bool pawsScrollBar::OnMouseDown	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		`[virtual]`

Manage mouse down event to test for and apply window changes.

Parameters:

button	Type of button: 1 resizable or movable, 2 context menu or config window.
modifiers	Used with PAWS_CONSTRUCTION.
x	Used to test for resize.
y	Used to test for resize.