A simple button widget. More...

#include <pawsbutton.h>

Public Member Functions
virtual void	Draw ()
	Draws the widget and all of it's children.
virtual void	Flash (bool state, FLASH_STATE type=FLASH_REGULAR)
virtual bool	GetState ()
const char *	GetText ()
virtual bool	IsDown ()
virtual bool	IsEnabled () const
virtual bool	OnKeyDown (utf32_char keyCode, utf32_char key, int modifiers)
	Process keydown messages.
virtual bool	OnMouseDown (int button, int modifiers, int x, int y)
	Manage mouse down event to test for and apply window changes.
virtual bool	OnMouseEnter ()
	Called whenever the mouse enters this widget.
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.
	pawsButton (const pawsButton &pb)
	pawsButton ()
bool	SelfPopulate (iDocumentNode *node)
	This function allows a widget to fill in its own contents from an xml node supplied and calls the same function for all children.
void	SetDownImage (const csString &image)
virtual void	SetEnabled (bool enabled)
void	SetGreyDownImage (const csString &greyDownImage)
void	SetGreyUpImage (const csString &greyUpImage)
virtual void	SetNotify (pawsWidget *widget)
void	SetOnSpecialImage (const csString &image)
void	SetSound (const char *sound)
virtual void	SetState (bool isDown, bool publish=true)
void	SetText (const char *text)
virtual void	SetToggle (bool t)
	Set the toggle attribute. To change toggle state use SetState.
virtual bool	Setup (iDocumentNode *node)
	Setup this widget.
void	SetUpImage (const csString &image)
virtual	~pawsButton ()
Protected Member Functions
virtual bool	CheckKeyHandled (int keyCode)
	Allow pawsButton to simulate button pushes based on keypresses.
Protected Attributes
csString	buttonLabel
	Text shown in button.
bool	changeOnMouseOver
	Whether or not to change image on mouse enter/exit.
bool	down
	Track to see if the button is down.
int	downTextOffsetX
int	downTextOffsetY
bool	enabled
int	flash
	The state if the button is flashing, 0 is no flashing.
FLASH_STATE	flashtype
	Type of flash (regular/special)
csRef< iPawsImage >	greyDownImage
csRef< iPawsImage >	greyUpImage
char	keybinding
	Keyboard equivalent of clicking on this button.
pawsWidget *	notify
	Widget to which event notifications are sent. If NULL, notifications go to parent.
int	originalFontColour
	Used when restoring from highlight state.
csRef< iPawsImage >	pressedImage
	Image to draw when button is pressed or when the mouse enters.
csRef< iPawsImage >	releasedImage
	Image to draw when button is released or when the mouse exits.
csString	sound_click
	Button can trigger sound effects with this.
csRef< iPawsImage >	specialFlashImage
	Image to draw when button is released.
int	style
	Style -- right now only ShadowText supported.
bool	toggle
	Check to see if this is a toggle button.
int	upTextOffsetX
int	upTextOffsetY

Detailed Description

A simple button widget.

Definition at line 43 of file pawsbutton.h.

Constructor & Destructor Documentation

pawsButton::pawsButton ( )

pawsButton::pawsButton ( const pawsButton & pb )

virtual pawsButton::~pawsButton ( ) [virtual]

Member Function Documentation

virtual bool pawsButton::CheckKeyHandled ( int ) [protected, virtual]

Allow pawsButton to simulate button pushes based on keypresses.

Return true if key is handled.

Reimplemented from pawsWidget.

Reimplemented in pawsDnDButton.

virtual void pawsButton::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.

Reimplemented in pawsDnDButton.

virtual void pawsButton::Flash	(	bool	state,
		FLASH_STATE	type = `FLASH_REGULAR`
	)		`[inline, virtual]`

Definition at line 96 of file pawsbutton.h.

virtual bool pawsButton::GetState ( ) [inline, virtual]

Reimplemented in pawsRadioButton.

Definition at line 76 of file pawsbutton.h.

const char* pawsButton::GetText ( ) [inline]

Definition at line 90 of file pawsbutton.h.

virtual bool pawsButton::IsDown ( ) [inline, virtual]

Definition at line 71 of file pawsbutton.h.

virtual bool pawsButton::IsEnabled ( ) const [virtual]

virtual bool pawsButton::OnKeyDown	(	utf32_char	keyCode,
		utf32_char	keyChar,
		int	modifiers
	)		`[virtual]`

Process keydown messages.

Parameters:

keyCode	The code for the pressed key.
keyChar	The key pressed.
modifiers	Used to modify tab behavior.

Returns:: bool TRUE for success FALSE if no action.

Remarks:: If you override this, be sure to also override GetFocusOverridesControls() as returning true

Reimplemented from pawsWidget.

virtual bool pawsButton::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.

Returns:: bool TRUE if movable or resizable.

Remarks:: calls OnMouseDown on it's parent.

Reimplemented from pawsWidget.

Reimplemented in pawsDnDButton.

virtual bool pawsButton::OnMouseEnter ( ) [virtual]

Called whenever the mouse enters this widget.

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

Remarks:: Acts recursively on it's parents.

Reimplemented from pawsWidget.

virtual bool pawsButton::OnMouseExit ( ) [virtual]

Called whenever the mouse leaves this widget.

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

Reimplemented from pawsWidget.

virtual bool pawsButton::OnMouseUp	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		`[virtual]`

Manage mouse up event.

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

Remarks:: Acts recursively on it's parents.

Reimplemented from pawsWidget.

Reimplemented in pawsDnDButton.

bool pawsButton::SelfPopulate ( iDocumentNode * node ) [virtual]

This function allows a widget to fill in its own contents from an xml node supplied and calls the same function for all children.

Parameters:

node	The xml data for the widget.

Returns:: bool TRUE if no children, FALSE if there are problems with a node.

Remarks:: User should overload this function to populate different types of widgets. Call this base class function to populate children. This is NOT the same as Setup(), which is defining height, width, styles, etc. This is data.

Reimplemented from pawsWidget.

Reimplemented in pawsDnDButton.

void pawsButton::SetDownImage ( const csString & image )