Public Member Functions | Private Types | Private Member Functions | Private Attributes

gui2::tdrawing Class Reference

A widget to draw upon. More...

#include <drawing.hpp>

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

List of all members.

Public Member Functions

 tdrawing ()
void set_active (const bool)
 Inherited from tcontrol.
bool get_active () const
 Inherited from tcontrol.
unsigned get_state () const
 Inherited from tcontrol.
bool disable_click_dismiss () const
 Inherited from tcontrol.
void set_best_size (const tpoint &best_size)

Private Types

enum  tstate { ENABLED, COUNT }
 

Possible states of the widget.

More...

Private Member Functions

tpoint calculate_best_size () const
 Inherited from tcontrol.
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

A widget to draw upon.

This widget has a fixed size like the spacer, but allows the user to manual draw items. The widget is display only.

Definition at line 29 of file drawing.hpp.


Member Enumeration Documentation

enum gui2::tdrawing::tstate [private]

Possible states of the widget.

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

Enumerator:
ENABLED 
COUNT 

Definition at line 76 of file drawing.hpp.


Constructor & Destructor Documentation

gui2::tdrawing::tdrawing (  )  [inline]

Definition at line 33 of file drawing.hpp.


Member Function Documentation

tpoint gui2::tdrawing::calculate_best_size (  )  const [inline, private, virtual]

Inherited from tcontrol.

Reimplemented from gui2::tcontrol.

Definition at line 43 of file drawing.hpp.

References best_size_.

bool gui2::tdrawing::disable_click_dismiss (  )  const [inline, virtual]

Inherited from tcontrol.

Reimplemented from gui2::tcontrol.

Definition at line 62 of file drawing.hpp.

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

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 56 of file drawing.hpp.

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

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 30 of file drawing.cpp.

References type.

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

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 59 of file drawing.hpp.

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

Inherited from tcontrol.

Implements gui2::tcontrol.

Definition at line 53 of file drawing.hpp.

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

Definition at line 66 of file drawing.hpp.

References best_size_.


Member Data Documentation

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

Definition at line 79 of file drawing.hpp.

Referenced by calculate_best_size(), and set_best_size().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by doxygen 1.7.1 on Thu May 24 2012 01:22:47 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs