$treeview $search $mathjax
Stratagus  2.2.6
$projectbrief
$projectbrief
$searchbox
-->
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
           Stratagus - A free fantasy real time strategy game engine

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.

Constructor & Destructor Documentation

gcn::CheckBox::CheckBox (  ) 

Contructor.

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

Constructor.

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

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

Destructor.


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.

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

Checks if the CheckBox is marked.

Returns:
true if the CheckBox is marked.

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

Sets the CheckBox to be marked.

Parameters:
marked true if the CheckBox should be marked.

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

Gets the CheckBox caption.

Returns:
the CheckBox caption.

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

Sets the CheckBox caption.

Parameters:
caption the CheckBox caption.

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

Adjusts the CheckBox size to fit the font size.

Reimplemented in ImageCheckBox.

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.

void gcn::CheckBox::drawBorder ( 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.

bool gcn::CheckBox::keyPress ( const 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.

void gcn::CheckBox::mouseClick ( int  ,
int  ,
int  ,
int   
) [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.

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

Toggles between marked and unmarked.


Member Data Documentation

bool gcn::CheckBox::mMarked [protected]

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


The documentation for this class was generated from the following files:
(C) Copyright 1998-2011 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.