pawsSpinBox Class Reference

A combination widget that has up and down arrows and a text label. More...

#include <pawsspinbox.h>

List of all members.

Public Member Functions
virtual float	GetValue ()
virtual bool	ManualSetup (csString &value, float Min, float Max, float Inc, csString &pos)
virtual bool	OnButtonPressed (int mouseButton, 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 void	OnLostFocus ()
	Sets hasFocus false and notifys parent.
	pawsSpinBox ()
	pawsSpinBox (const pawsSpinBox &origin)
virtual bool	Perform (iTimerEvent *ev)
virtual void	SetRange (float Min, float Max, float Inc)
virtual bool	Setup (iDocumentNode *node)
	Setup this widget.
virtual void	SetValue (float value)
virtual void	Spin ()
virtual	~pawsSpinBox ()

---

Detailed Description

A combination widget that has up and down arrows and a text label.

This widget is defined in an XML as:

<widget name="nameHere" factory="pawsSpinBox" id="intIDNumber"> <!-- The size of the entire widget including text and button. --> <frame x="75" y="5" width="70" height="30" />

<!-- The text label to use and it's position relative to the button --> <number default="5" min="0" max="100" inc="1" position="right"/> </widget>

Current supported positions are left/right.

Definition at line 56 of file pawsspinbox.h.

---

Constructor & Destructor Documentation

pawsSpinBox::pawsSpinBox

(

)

virtual pawsSpinBox::~pawsSpinBox

(

)

[virtual]

pawsSpinBox::pawsSpinBox

(

const pawsSpinBox &

origin

)

---

Member Function Documentation

virtual float pawsSpinBox::GetValue

(

)

[virtual]

virtual bool pawsSpinBox::ManualSetup	(	csString &	value,
		float	Min,
		float	Max,
		float	Inc,
		csString &	pos
	)		[virtual]

virtual bool pawsSpinBox::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 pawsSpinBox::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 void pawsSpinBox::OnLostFocus

(

)

[virtual]

Sets hasFocus false and notifys parent.

Reimplemented from pawsWidget.

virtual bool pawsSpinBox::Perform

(

iTimerEvent *

ev

)

[virtual]

virtual void pawsSpinBox::SetRange	(	float	Min,
		float	Max,
		float	Inc
	)		[virtual]

virtual bool pawsSpinBox::Setup

(

iDocumentNode *

)

[virtual]

Setup this widget.

Reimplemented from pawsWidget.

virtual void pawsSpinBox::SetValue

(

float

value

)

[virtual]

virtual void pawsSpinBox::Spin

(

)

[virtual]

---

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

• common/paws/pawsspinbox.h