gcn::CheckBox Class Reference

#include <checkbox.hpp>

Inheritance diagram for gcn::CheckBox:

gcn::Widget gcn::MouseListener gcn::KeyListener List of all members.

Detailed Description

A regular CheckBox.

It can be checked and unchecked.

Definition at line 72 of file checkbox.hpp.

Public Member Functions

 CheckBox ()
 Contructor.
 CheckBox (const std::string &caption, bool marked=false)
 Constructor.
virtual ~CheckBox ()
 Destructor.
virtual void drawBox (Graphics *graphics)
 Draws the box i.a not the caption.
virtual bool isMarked () const
 Checks if the CheckBox is marked.
virtual void setMarked (bool marked)
 Sets the CheckBox to be marked.
virtual const std::string & getCaption () const
 Gets the CheckBox caption.
virtual void setCaption (const std::string &caption)
 Sets the CheckBox caption.
virtual void adjustSize ()
 Adjusts the CheckBox size to fit the font size.
virtual void draw (Graphics *graphics)
 Draws the Widget.
virtual void drawBorder (Graphics *graphics)
 Draws the Widget border.
virtual void keyPress (const Key &key)
 Called if a key is pressed when the widget has keyboard focus.
virtual void mouseClick (int x, int y, int button, int count)
 Called when a mouse button is pressed and released (clicked) when the mouse is in the Widget area or if the Widget has focus.

Protected Member Functions

virtual void toggle ()
 Toggles between marked and unmarked.

Protected Attributes

bool mMarked
std::string mCaption


Constructor & Destructor Documentation

gcn::CheckBox::CheckBox ( const std::string &  caption,
bool  marked = false 
)

Constructor.

Parameters:
caption the CheckBox caption.
marked true if the CheckBox should be marked.

Definition at line 80 of file checkbox.cpp.

References gcn::Widget::addKeyListener(), gcn::Widget::addMouseListener(), adjustSize(), setCaption(), gcn::Widget::setFocusable(), and setMarked().


Member Function Documentation

void gcn::CheckBox::draw ( Graphics graphics  )  [virtual]

Draws the Widget.

It is called by the parent widget when it is time for the Widget to draw itself. The graphics object is set up so that all drawing is relative to the Widget, i.e coordinate (0,0) is the top-left corner of the Widget. It is not possible to draw outside of a Widgets dimension.

Parameters:
graphics a Graphics object to draw with.

Implements gcn::Widget.

Definition at line 92 of file checkbox.cpp.

References drawBox(), gcn::Graphics::drawRectangle(), gcn::Graphics::drawText(), getCaption(), gcn::Widget::getFont(), gcn::Widget::getForegroundColor(), gcn::Widget::getHeight(), gcn::Widget::getWidth(), gcn::Widget::isFocused(), gcn::Graphics::setColor(), and gcn::Graphics::setFont().

void gcn::CheckBox::drawBorder ( Graphics graphics  )  [virtual]

Draws the Widget border.

A border is drawn around a Widget. The width and height of the border is therefore the Widgets height+2*bordersize. Think of a painting that has a certain size, the border surrounds the painting.

Parameters:
graphics a Graphics object to draw with.

Reimplemented from gcn::Widget.

Definition at line 109 of file checkbox.cpp.

References gcn::Color::a, gcn::Graphics::drawLine(), gcn::Widget::getBaseColor(), gcn::Widget::getBorderSize(), gcn::Widget::getHeight(), gcn::Widget::getWidth(), and gcn::Graphics::setColor().

void gcn::CheckBox::drawBox ( Graphics graphics  )  [virtual]

Draws the box i.a not the caption.

Parameters:
graphics a Graphics object to draw with.

Definition at line 133 of file checkbox.cpp.

References gcn::Color::a, gcn::Graphics::drawLine(), gcn::Graphics::fillRectangle(), gcn::Widget::getBackgroundColor(), gcn::Widget::getBaseColor(), gcn::Widget::getForegroundColor(), gcn::Widget::getHeight(), mMarked, and gcn::Graphics::setColor().

Referenced by draw().

const std::string & gcn::CheckBox::getCaption (  )  const [virtual]

Gets the CheckBox caption.

Returns:
the CheckBox caption.

Definition at line 178 of file checkbox.cpp.

References mCaption.

Referenced by draw().

bool gcn::CheckBox::isMarked (  )  const [virtual]

Checks if the CheckBox is marked.

Returns:
true if the CheckBox is marked.

Definition at line 168 of file checkbox.cpp.

References mMarked.

void gcn::CheckBox::keyPress ( const Key key  )  [virtual]

Called if a key is pressed when the widget has keyboard focus.

If a key is held down the widget will generate multiple key presses.

Parameters:
key the key pressed.

Reimplemented from gcn::KeyListener.

Definition at line 188 of file checkbox.cpp.

References gcn::Key::getValue(), and toggle().

void gcn::CheckBox::mouseClick ( int  x,
int  y,
int  button,
int  count 
) [virtual]

Called when a mouse button is pressed and released (clicked) when the mouse is in the Widget area or if the Widget has focus.

Parameters:
x the x coordinate of the mouse relative to the Widget itself.
y the y coordinate of the mouse relative to the Widget itself.
button the button clicked.
count the number of clicks.

Reimplemented from gcn::MouseListener.

Definition at line 197 of file checkbox.cpp.

References toggle().

void gcn::CheckBox::setCaption ( const std::string &  caption  )  [virtual]

Sets the CheckBox caption.

Parameters:
caption the CheckBox caption.

Definition at line 183 of file checkbox.cpp.

References mCaption.

Referenced by CheckBox().

void gcn::CheckBox::setMarked ( bool  marked  )  [virtual]

Sets the CheckBox to be marked.

Parameters:
marked true if the CheckBox should be marked.

Definition at line 173 of file checkbox.cpp.

References mMarked.

Referenced by CheckBox().


The documentation for this class was generated from the following files:
Generated on Sat Jul 29 19:38:49 2006 for Guichan by  doxygen 1.4.7