pawsCheckBox Class Reference

A combination widget that has a check box and a text label. More...

#include <pawscheckbox.h>

List of all members.

Public Member Functions
pawsButton *	GetButton ()
	@@ Hack: please someone tell me how to do this better?
virtual double	GetProperty (MathEnvironment *env, const char *ptr)
virtual bool	GetState ()
	Return whether the checkbox is "checked" or "unchecked".
virtual const char *	GetText ()
	Return the text contained within the checkbox.
bool	OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
	This function is not yet documented.
virtual void	OnUpdateData (const char *dataname, PAWSData &data)
	This function is not yet documented.
	pawsCheckBox (const pawsCheckBox &origin)
	pawsCheckBox ()
	This function is not yet documented.
bool	SelfPopulate (iDocumentNode *node)
	This function is not yet documented.
virtual void	SetImages (const char *up, const char *down)
	This function is not yet documented.
virtual void	SetProperty (const char *ptr, double value)
	Set the value of the specified property.
virtual void	SetState (bool state)
	Set whether the checkbox is "checked" or "unchecked".
virtual void	SetText (const char *string)
	Set the text contained in the checkbox.
virtual bool	Setup (iDocumentNode *node)
	This function is not yet documented.
virtual	~pawsCheckBox ()
	This function is not yet documented.

---

Detailed Description

A combination widget that has a check box and a text label.

This widget is defined in an XML as:

<widget name="nameHere" factory="pawsCheckBox" 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 --> <text string="Sell" position="right"/> </widget>

Current supported positions are left/right.

By default it uses the checkon/checkoff named images and automatically assumes that their size is 16x16.

Definition at line 48 of file pawscheckbox.h.

---

Constructor & Destructor Documentation

pawsCheckBox::pawsCheckBox

(

)

This function is not yet documented.

pawsCheckBox::pawsCheckBox

(

const pawsCheckBox &

origin

)

pawsCheckBox::~pawsCheckBox

(

)

[virtual]

This function is not yet documented.

---

Member Function Documentation

pawsButton* pawsCheckBox::GetButton

(

)

[inline]

@@ Hack: please someone tell me how to do this better?

Definition at line 160 of file pawscheckbox.h.

virtual double pawsCheckBox::GetProperty	(	MathEnvironment *	env,
		const char *	ptr
	)		[virtual]

Reimplemented from pawsWidget.

bool pawsCheckBox::GetState

(

)

[virtual]

Return whether the checkbox is "checked" or "unchecked".

Return the value of the value of the checkbox in boolean form. True = "checked" False = "unchecked"

const char * pawsCheckBox::GetText

(

)

[virtual]

Return the text contained within the checkbox.

bool pawsCheckBox::OnButtonPressed	(	int	mouseButton,
		int	keyModifier,
		pawsWidget *	widget
	)		[virtual]

This function is not yet documented.

Parameters:

mouseButton	TODO.
keyModifier	TODO.
*widget	TODO.

Reimplemented from pawsWidget.

void pawsCheckBox::OnUpdateData	(	const char *	dataname,
		PAWSData &	data
	)		[virtual]

This function is not yet documented.

Parameters:

*dataname	TODO.
data	TODO.

Reimplemented from pawsWidget.

bool pawsCheckBox::SelfPopulate

(

iDocumentNode *

node

)

[virtual]

This function is not yet documented.

Parameters:

*node

TODO.

Reimplemented from pawsWidget.

void pawsCheckBox::SetImages	(	const char *	up,
		const char *	down
	)		[virtual]

This function is not yet documented.

Parameters:

*up	TODO.
*down	TODO.

void pawsCheckBox::SetProperty	(	const char *	ptr,
		double	value
	)		[virtual]

Set the value of the specified property.

Parameters:

*ptr	The name of the property to set.
value	The new value of the property to be set.

Reimplemented from pawsWidget.

void pawsCheckBox::SetState

(

bool

state

)

[virtual]

Set whether the checkbox is "checked" or "unchecked".

Parameters:

state

The desired value: True = checked, False = unchecked.

void pawsCheckBox::SetText

(

const char *

string

)

[virtual]

Set the text contained in the checkbox.

Parameters:

string

The text to which checkbox should be set.

bool pawsCheckBox::Setup

(

iDocumentNode *

node

)

[virtual]

This function is not yet documented.

Parameters:

*node

TODO.

Reimplemented from pawsWidget.

---

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

• common/paws/pawscheckbox.h