____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

gcn::CheckBox Class Reference

#include <checkbox.h>

Inheritance diagram for gcn::CheckBox:

gcn::Widget gcn::MouseListener gcn::KeyListener ImageCheckBox

List of all members.

Public Member Functions

 CheckBox ()
 CheckBox (const std::string &caption, bool marked=false)
virtual ~CheckBox ()
virtual void drawBox (Graphics *graphics)
virtual bool isMarked () const
virtual void setMarked (bool marked)
virtual const std::string & getCaption () const
virtual void setCaption (const std::string &caption)
virtual void adjustSize ()
virtual void draw (Graphics *graphics)
virtual void drawBorder (Graphics *graphics)
virtual bool keyPress (const Key &key)
virtual void mouseClick (int x, int y, int button, int count)

Protected Member Functions

virtual void toggle ()

Protected Attributes

bool mMarked
std::string mCaption

Detailed Description

A regular CheckBox. It can be checked and unchecked.

Definition at line 70 of file checkbox.h.

Constructor & Destructor Documentation

gcn::CheckBox::CheckBox (  ) 

Contructor.

Definition at line 64 of file checkbox.cpp.

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

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 73 of file checkbox.cpp.

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

virtual gcn::CheckBox::~CheckBox (  )  [inline, virtual]

Destructor.

Definition at line 93 of file checkbox.h.

Member Function Documentation

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

Draws the box i.a not the caption.

Parameters:
graphics a Graphics object to draw with.

Reimplemented in ImageCheckBox.

Definition at line 126 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().

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

Checks if the CheckBox is marked.

Returns:
true if the CheckBox is marked.

Definition at line 161 of file checkbox.cpp.

References mMarked.

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 166 of file checkbox.cpp.

References mMarked.

Referenced by CheckBox().

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

Gets the CheckBox caption.

Returns:
the CheckBox caption.

Definition at line 171 of file checkbox.cpp.

References mCaption.

Referenced by ImageCheckBox::draw(), and draw().

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

Sets the CheckBox caption.

Parameters:
caption the CheckBox caption.

Definition at line 176 of file checkbox.cpp.

References mCaption, and gcn::Widget::setDirty().

Referenced by CheckBox().

void gcn::CheckBox::adjustSize (  )  [virtual]

Adjusts the CheckBox size to fit the font size.

Reimplemented in ImageCheckBox.

Definition at line 201 of file checkbox.cpp.

References gcn::Widget::getFont(), gcn::Font::getHeight(), gcn::Widget::getWidth(), mCaption, gcn::Widget::setHeight(), and gcn::Widget::setWidth().

Referenced by CheckBox().

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.

Reimplemented in ImageCheckBox.

Definition at line 85 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::hasFocus(), gcn::Graphics::setColor(), and gcn::Graphics::setFont().

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

Draws a 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 102 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().

bool 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 182 of file checkbox.cpp.

References gcn::Key::ENTER, gcn::Key::getValue(), gcn::Key::SPACE, 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.

Reimplemented in ImageCheckBox.

Definition at line 193 of file checkbox.cpp.

References gcn::MouseInput::LEFT, and toggle().

void gcn::CheckBox::toggle (  )  [protected, virtual]

Toggles between marked and unmarked.

Definition at line 209 of file checkbox.cpp.

References gcn::Widget::generateAction(), and mMarked.

Referenced by keyPress(), ImageCheckBox::mouseClick(), and mouseClick().

Member Data Documentation

bool gcn::CheckBox::mMarked [protected]

Definition at line 159 of file checkbox.h.

Referenced by ImageCheckBox::drawBox(), drawBox(), isMarked(), setMarked(), and toggle().

std::string gcn::CheckBox::mCaption [protected]

Definition at line 160 of file checkbox.h.

Referenced by ImageCheckBox::adjustSize(), adjustSize(), getCaption(), and setCaption().

The documentation for this class was generated from the following files:
Generated on Sat Feb 21 00:28:26 2009 for Bos Wars by  doxygen 1.5.6