Public Member Functions | Private Types | Private Member Functions

gui2::timage Class Reference

An image. More...

#include <image.hpp>

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

List of all members.

Public Member Functions

 timage ()
void set_image (const t_string &label)
 Wrapper for set_label.
t_string get_image () const
 Wrapper for label.
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.

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.

Detailed Description

An image.

Definition at line 24 of file image.hpp.


Member Enumeration Documentation

enum gui2::timage::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 87 of file image.hpp.


Constructor & Destructor Documentation

gui2::timage::timage (  )  [inline]

Definition at line 28 of file image.hpp.

References COUNT, and timage().

Referenced by timage().

Here is the call graph for this function:

Here is the caller graph for this function:


Member Function Documentation

tpoint gui2::timage::calculate_best_size (  )  const [private]

Inherited from tcontrol.

bool gui2::timage::disable_click_dismiss (  )  const [inline]

Inherited from tcontrol.

Definition at line 78 of file image.hpp.

bool gui2::timage::get_active (  )  const [inline]

Inherited from tcontrol.

Definition at line 72 of file image.hpp.

const std::string& gui2::timage::get_control_type (  )  const [private]

Inherited from tcontrol.

t_string gui2::timage::get_image (  )  const [inline]

Wrapper for label.

Some people considered this function missing and confusing so added this forward version.

Returns:
The filename of the image shown.

Definition at line 54 of file image.hpp.

unsigned gui2::timage::get_state (  )  const [inline]

Inherited from tcontrol.

Definition at line 75 of file image.hpp.

void gui2::timage::set_active ( const   bool  )  [inline]

Inherited from tcontrol.

Definition at line 69 of file image.hpp.

void gui2::timage::set_image ( const t_string label  )  [inline]

Wrapper for set_label.

Some people considered this function missing and confusing so added this forward version.

Parameters:
label The filename image to show.

Definition at line 41 of file image.hpp.

References set_image(), and gui2::set_label().

Referenced by set_image().

Here is the call graph for this function:

Here is the caller graph for this function:


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

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