gui2::tspacer Class Reference

#include <spacer.hpp>

Inheritance diagram for gui2::tspacer:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 tspacer ()
void set_active (const bool)
 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.
void draw (surface &)
 Inherited from twidget.
void set_best_size (const tpoint &best_size)
tpoint get_best_size () const
 Inherited from tcontrol.

Private Member Functions

const std::string & get_control_type () const
 Inherited from tcontrol.

Private Attributes

tpoint best_size_
 When we're used as a fixed size item, this holds the best size.


Detailed Description

Definition at line 23 of file spacer.hpp.


Constructor & Destructor Documentation

gui2::tspacer::tspacer (  )  [inline]

Definition at line 26 of file spacer.hpp.


Member Function Documentation

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

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 34 of file spacer.hpp.

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

Gets the active state of the control.

Implements gui2::tcontrol.

Definition at line 35 of file spacer.hpp.

unsigned gui2::tspacer::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 spacer.hpp.

void gui2::tspacer::draw ( surface surface  )  [inline, virtual]

Inherited from twidget.

Reimplemented from gui2::tcontrol.

Definition at line 38 of file spacer.hpp.

void gui2::tspacer::set_best_size ( const tpoint best_size  )  [inline]

Definition at line 40 of file spacer.hpp.

References best_size_.

tpoint gui2::tspacer::get_best_size (  )  const [inline, virtual]

Inherited from tcontrol.

Reimplemented from gui2::tcontrol.

Definition at line 43 of file spacer.hpp.

References best_size_, and gui2::tcontrol::get_best_size().

Referenced by gui2::tlistbox::set_size().

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

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 52 of file spacer.hpp.

References type.


Member Data Documentation

When we're used as a fixed size item, this holds the best size.

Definition at line 49 of file spacer.hpp.

Referenced by get_best_size(), and set_best_size().


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

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