gui2::tlabel Class Reference

#include <label.hpp>

Inheritance diagram for gui2::tlabel:

Inheritance graph
[legend]
Collaboration diagram for gui2::tlabel:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 tlabel ()
void set_active (const bool active)
 Inherited from tcontrol.
bool get_active () const
 Gets the active state of the control.
unsigned get_state () const
 Returns the id of the state, which is also the index for the canvas.

Private Types

enum  tstate { ENABLED, DISABLED, COUNT }
 Note the order of the states must be the same as defined in settings.hpp. More...

Private Member Functions

void set_state (tstate state)
const std::string & get_control_type () const
 Inherited from tcontrol.

Private Attributes

tstate state_


Detailed Description

Definition at line 22 of file gui/widgets/label.hpp.


Member Enumeration Documentation

enum gui2::tlabel::tstate [private]

Note the order of the states must be the same as defined in settings.hpp.

Enumerator:
ENABLED 
DISABLED 
COUNT 

Definition at line 40 of file gui/widgets/label.hpp.


Constructor & Destructor Documentation

gui2::tlabel::tlabel (  )  [inline]

Definition at line 26 of file gui/widgets/label.hpp.


Member Function Documentation

void gui2::tlabel::set_active ( const bool  active  )  [inline, virtual]

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 33 of file gui/widgets/label.hpp.

References DISABLED, ENABLED, get_active(), and set_state().

bool gui2::tlabel::get_active (  )  const [inline, virtual]

Gets the active state of the control.

Implements gui2::tcontrol.

Definition at line 35 of file gui/widgets/label.hpp.

References DISABLED, and state_.

Referenced by set_active().

unsigned gui2::tlabel::get_state (  )  const [inline, virtual]

Returns the id of the state, which is also the index for the canvas.

Implements gui2::tcontrol.

Definition at line 36 of file gui/widgets/label.hpp.

References state_.

void gui2::tlabel::set_state ( tstate  state  )  [private]

Definition at line 42 of file gui/widgets/label.cpp.

References gui2::twidget::set_dirty(), and state_.

Referenced by set_active().

const std::string& gui2::tlabel::get_control_type (  )  const [inline, private, virtual]

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 46 of file gui/widgets/label.hpp.

References type.


Member Data Documentation

Definition at line 43 of file gui/widgets/label.hpp.

Referenced by get_active(), get_state(), and set_state().


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs