$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::RadioButton Class Reference

#include <radiobutton.h>

Inheritance diagram for gcn::RadioButton:

gcn::Widget gcn::MouseListener gcn::KeyListener ImageRadioButton

List of all members.


Public Member Functions

 RadioButton ()
 RadioButton (const std::string &caption, const std::string &group, bool marked=false)
virtual ~RadioButton ()
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 setGroup (const std::string &group)
virtual const std::string & getGroup () const
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 Types

typedef std::multimap
< std::string, RadioButton * > 
GroupMap
typedef GroupMap::iterator GroupIterator

Protected Attributes

bool mMarked
std::string mCaption
std::string mGroup

Static Protected Attributes

static GroupMap mGroupMap

Detailed Description

A RadioButton which can be grouped into RadioButtons groups. In a RadioButton group, only one of the RadioButtons can be selected.

Member Typedef Documentation

typedef std::multimap<std::string, RadioButton *> gcn::RadioButton::GroupMap [protected]

typedef GroupMap::iterator gcn::RadioButton::GroupIterator [protected]


Constructor & Destructor Documentation

gcn::RadioButton::RadioButton (  ) 

Constructor.

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

Constructor.

Parameters:
caption the Radiobutton caption.
group the group the RadioButton belongs to.
marked true if the RadioButton should be marked.

gcn::RadioButton::~RadioButton (  )  [virtual]

Destructor.


Member Function Documentation

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

Draws the box i.a not the caption.

Parameters:
graphics a Graphics object to draw with.

Reimplemented in ImageRadioButton.

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

Checks if the RadioButton is marked.

Returns:
true if the RadioButton is marked.

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

Sets the RadioButton to be marked.

Parameters:
marked true if the RadioButton should be marked.

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

Gets the RadioButton caption.

Returns:
the RadioButton caption.

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

Sets the RadioButton caption.

Parameters:
caption the RadioButton caption.

void gcn::RadioButton::setGroup ( const std::string &  group  )  [virtual]

Sets the group the RadioButton should belong to.

Parameters:
group the name of the group.

const std::string & gcn::RadioButton::getGroup (  )  const [virtual]

Gets the group the RadioButton belongs to.

Returns:
the group the RadioButton belongs to.

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

Adjusts the RadioButtons size to fit the font size.

Reimplemented in ImageRadioButton.

void gcn::RadioButton::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 ImageRadioButton.

void gcn::RadioButton::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::RadioButton::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::RadioButton::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 ImageRadioButton.


Member Data Documentation

bool gcn::RadioButton::mMarked [protected]

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

std::string gcn::RadioButton::mGroup [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.