The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Public Attributes | List of all members
gui2::tbuilder_widget Struct Referenceabstract

Contains the info needed to instantiate a widget. More...

#include <window_builder.hpp>

Inheritance diagram for gui2::tbuilder_widget:
Inheritance graph

Public Types

typedef std::map< std::string,
boost::intrusive_ptr
< tbuilder_widget > > 
treplacements
 The replacements type is used to define replacement types. More...
 

Public Member Functions

 tbuilder_widget (const config &cfg)
 
virtual ~tbuilder_widget ()
 
virtual twidgetbuild () const =0
 
virtual twidgetbuild (const treplacements &replacements) const =0
 
- Public Member Functions inherited from reference_counted_object
 reference_counted_object ()
 
 reference_counted_object (const reference_counted_object &)
 
reference_counted_objectoperator= (const reference_counted_object &)
 
virtual ~reference_counted_object ()
 
void add_ref () const
 
void dec_ref () const
 
int refcount () const
 

Public Attributes

std::string id
 Parameters for the widget. More...
 
std::string linked_group
 
int debug_border_mode
 
unsigned debug_border_color
 

Additional Inherited Members

- Protected Member Functions inherited from reference_counted_object
void turn_reference_counting_off () const
 

Detailed Description

Contains the info needed to instantiate a widget.

Definition at line 42 of file window_builder.hpp.

Member Typedef Documentation

The replacements type is used to define replacement types.

Certain widgets need to build a part of themselves upon instantiation but at the time of the definition it's not yet known what exactly. By using and `[instance]' widget this decision can be postponed until instantiation.

Definition at line 54 of file window_builder.hpp.

Constructor & Destructor Documentation

gui2::tbuilder_widget::tbuilder_widget ( const config cfg)
explicit

Definition at line 138 of file window_builder.cpp.

virtual gui2::tbuilder_widget::~tbuilder_widget ( )
inlinevirtual

Definition at line 58 of file window_builder.hpp.

Member Function Documentation

virtual twidget* gui2::tbuilder_widget::build ( ) const
pure virtual
virtual twidget* gui2::tbuilder_widget::build ( const treplacements replacements) const
pure virtual

Member Data Documentation

unsigned gui2::tbuilder_widget::debug_border_color
int gui2::tbuilder_widget::debug_border_mode
std::string gui2::tbuilder_widget::id

Parameters for the widget.

Definition at line 67 of file window_builder.hpp.

std::string gui2::tbuilder_widget::linked_group

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