gui2::gui_definition Class Reference

A GUI theme definition. More...

#include <gui_definition.hpp>

Classes
struct	settings_helper
	Theme-specific settings. More...

Public Types
using	widget_definition_map_t = std::map< std::string, styled_widget_definition_ptr >

Public Member Functions
	gui_definition (const config &cfg)
	Private ctor. More...
void	activate () const
	Activates this GUI. More...
t_string	description ()

Public Attributes
std::map< std::string, widget_definition_map_t >	widget_types
	Map of each widget type, by id, and a sub-map of each of the type's definitions, also by id. More...
std::map< std::string, builder_window >	window_types
	Map of all known windows (the builder class builds a window). More...

Private Attributes
std::string	id_
t_string	description_
settings_helper	settings_
std::vector< game_tip >	tips_

Detailed Description

A GUI theme definition.

Each theme defines the appearance and layout of widgets and windows. At least one theme (the default) must exist for the game to run. That theme is expected to contain at least one default definition for each widget type and a layout for each window recorded in the static registry. Do note that a widget type may have any number of definitions defined per theme, but a window may only have one layout.

Non-default themes may omit a default widget definition or a window layout, in which case the game will fall back on the default definition (for widgets) or the layout (for windows) specified in the default theme.

Each widget definition and window layout may also define different variations of itself to be used based on the current game resolution.

Definition at line 44 of file gui_definition.hpp.

Member Typedef Documentation

widget_definition_map_t

using gui2::gui_definition::widget_definition_map_t = std::map<std::string, styled_widget_definition_ptr>

Definition at line 50 of file gui_definition.hpp.

Constructor & Destructor Documentation

gui_definition()

gui2::gui_definition::gui_definition ( const config &  cfg )

explicit

Private ctor.

Use create to initialize a new definition.

Parse widget definitions of each registered type.

Parse each window.

Definition at line 36 of file gui_definition.cpp.

References _(), config::child_range(), DBG_GUI_P, description_, t_string::empty(), ERR_GUI_P, id_, missing_mandatory_wml_key(), gui2::registered_widget_types(), gui2::registered_window_types(), VALIDATE, w, widget_types, and window_types.

Member Function Documentation

activate()

void gui2::gui_definition::activate

(

)

const

Activates this GUI.

Definition at line 128 of file gui_definition.cpp.

References gui2::gui_definition::settings_helper::double_click_time, gui2::settings::double_click_time, gui2::gui_definition::settings_helper::has_helptip_message, gui2::settings::has_helptip_message, gui2::gui_definition::settings_helper::help_show_time, gui2::settings::help_show_time, gui2::gui_definition::settings_helper::popup_show_delay, gui2::settings::popup_show_delay, gui2::gui_definition::settings_helper::popup_show_time, gui2::settings::popup_show_time, gui2::gui_definition::settings_helper::repeat_button_repeat_time, gui2::settings::repeat_button_repeat_time, settings_, gui2::gui_definition::settings_helper::sound_button_click, gui2::settings::sound_button_click, gui2::gui_definition::settings_helper::sound_slider_adjust, gui2::settings::sound_slider_adjust, gui2::gui_definition::settings_helper::sound_toggle_button_click, gui2::settings::sound_toggle_button_click, gui2::gui_definition::settings_helper::sound_toggle_panel_click, gui2::settings::sound_toggle_panel_click, gui2::settings::tips, and tips_.

description()

t_string gui2::gui_definition::description ( )

inline

Definition at line 61 of file gui_definition.hpp.

References description_.

Member Data Documentation

description_

t_string gui2::gui_definition::description_

private

Definition at line 68 of file gui_definition.hpp.

Referenced by description(), and gui_definition().

id_

std::string gui2::gui_definition::id_

private

Definition at line 66 of file gui_definition.hpp.

Referenced by gui_definition().

settings_

settings_helper gui2::gui_definition::settings_

private

Definition at line 99 of file gui_definition.hpp.

Referenced by activate().

tips_

std::vector<game_tip> gui2::gui_definition::tips_

private

Definition at line 101 of file gui_definition.hpp.

Referenced by activate().

widget_types

std::map<std::string, widget_definition_map_t> gui2::gui_definition::widget_types

Map of each widget type, by id, and a sub-map of each of the type's definitions, also by id.

Definition at line 53 of file gui_definition.hpp.

Referenced by gui2::get_control(), and gui_definition().

window_types

std::map<std::string, builder_window> gui2::gui_definition::window_types

Map of all known windows (the builder class builds a window).

Definition at line 56 of file gui_definition.hpp.

Referenced by gui_definition().

---

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

• gui/core/gui_definition.hpp
• gui/core/gui_definition.cpp