WoopsiUI::CheckBox Class Reference

#include <checkbox.h>

Inheritance diagram for WoopsiUI::CheckBox:
WoopsiUI::Button WoopsiUI::Label WoopsiUI::Gadget

List of all members.

Public Types

enum  CheckBoxState { CHECK_BOX_STATE_OFF = 0, CHECK_BOX_STATE_ON = 1, CHECK_BOX_STATE_MU = 2 }

Public Member Functions

 CheckBox (s16 x, s16 y, u16 width, u16 height, FontBase *font=NULL)
virtual void draw (Rect clipRect)
virtual bool click (s16 x, s16 y)
virtual const CheckBoxState getState () const
virtual void setState (CheckBoxState state)

Protected Member Functions

virtual ~CheckBox ()
 CheckBox (const CheckBox &checkBox)

Protected Attributes

CheckBoxState _state

Detailed Description

Class representing a radio button. Like radio buttons, checkboxes are tri-state - off, on and "mu". The mu state cannot be enabled by a user - it can only be set by the developer.


Member Enumeration Documentation

Enum listing all possible checkbox states.

Enumerator:
CHECK_BOX_STATE_OFF 

Checkbox is unticked

CHECK_BOX_STATE_ON 

Checkbox is ticked

CHECK_BOX_STATE_MU 

Checkbox is in the third state


Constructor & Destructor Documentation

WoopsiUI::CheckBox::CheckBox ( s16  x,
s16  y,
u16  width,
u16  height,
FontBase font = NULL 
)

Constructor.

Parameters:
x The x co-ordinate of the checkbox, relative to its parent.
y The y co-ordinate of the checkbox, relative to its parent.
width The width of the checkbox.
height The height of the checkbox.
font The font to use for the checkbox.
virtual WoopsiUI::CheckBox::~CheckBox (  )  [inline, protected, virtual]

Destructor.

WoopsiUI::CheckBox::CheckBox ( const CheckBox checkBox  )  [inline, protected]

Copy constructor is protected to prevent usage.


Member Function Documentation

virtual bool WoopsiUI::CheckBox::click ( s16  x,
s16  y 
) [virtual]

Click this gadget at the supplied co-ordinates.

Parameters:
x X co-ordinate of the click.
y Y co-ordinate of the click.
Returns:
True if the click was successful.

Reimplemented from WoopsiUI::Button.

virtual void WoopsiUI::CheckBox::draw ( Rect  clipRect  )  [virtual]

Draw the area of this gadget that falls within the clipping region. Called by the draw() function to draw all visible regions.

Parameters:
clipRect The clipping region to draw.
See also:
draw()

Reimplemented from WoopsiUI::Button.

virtual const CheckBoxState WoopsiUI::CheckBox::getState (  )  const [inline, virtual]

Get the current state of the checkbox.

Returns:
The state of the checkbox.
virtual void WoopsiUI::CheckBox::setState ( CheckBoxState  state  )  [virtual]

Set the state of the checkbox.

Parameters:
state The new checkbox state.

Member Data Documentation

The state of the checkbox


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

Generated on Sun Nov 15 11:35:36 2009 for Woopsi by  doxygen 1.6.1