The Battle for Wesnoth  1.15.12+dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::select_orb_colors Class Reference

#include <select_orb_colors.hpp>

Inheritance diagram for gui2::dialogs::select_orb_colors:

Public Member Functions

 select_orb_colors ()
 
- Public Member Functions inherited from gui2::dialogs::modal_dialog
 modal_dialog ()
 
virtual ~modal_dialog ()
 
bool show (const unsigned auto_close_time=0)
 Shows the window. More...
 
windowget_window () const
 Returns a pointer to the dialog's window. More...
 
int get_retval () const
 Returns the cached window exit code. More...
 
void set_retval (int retval)
 Convenience wrapper to set the window's exit code. More...
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 
void set_allow_plugin_skip (const bool allow_plugin_skip)
 
void set_show_even_without_video (const bool show_even_without_video)
 

Private Member Functions

void setup_orb_toggle (const std::string &base_id, bool &shown)
 The display function. More...
 
void setup_orb_group (const std::string &base_id, bool &shown, const std::string &initial)
 
void reset_orb_toggle (const std::string &base_id, bool &shown)
 
void reset_orb_group (const std::string &base_id, bool &shown, const std::string &initial)
 
void toggle_orb_callback (bool &storage)
 
void reset_orb_callback ()
 
virtual const std::string & window_id () const override
 The id of the window to build. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 

Private Attributes

bool show_unmoved_
 
bool show_partial_
 
bool show_disengaged_
 
bool show_moved_
 
bool show_ally_
 
bool show_enemy_
 
std::map< std::string, group< std::string > > groups_
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::dialogs::modal_dialog
field_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> callback_load_value=nullptr, const std::function< void(bool)> callback_save_value=nullptr, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> callback_load_value=nullptr, const std::function< void(int)> callback_save_value=nullptr)
 Creates a new integer field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> callback_load_value=nullptr, const std::function< void(const std::string &)> callback_save_value=nullptr, const bool capture_focus=false)
 Creates a new text field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
field_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new styled_widget as a label. More...
 
field_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new styled_widget as image. More...
 
- Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

Definition at line 23 of file select_orb_colors.hpp.

Constructor & Destructor Documentation

◆ select_orb_colors()

gui2::dialogs::select_orb_colors::select_orb_colors ( )

Definition at line 44 of file select_orb_colors.cpp.

Member Function Documentation

◆ post_show()

void gui2::dialogs::select_orb_colors::post_show ( window window)
overrideprivatevirtual

◆ pre_show()

void gui2::dialogs::select_orb_colors::pre_show ( window window)
overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 54 of file select_orb_colors.cpp.

References preferences::allied_color(), gui2::event::connect_signal_mouse_left_click(), preferences::enemy_color(), preferences::moved_color(), preferences::partial_color(), reset_orb_callback(), setup_orb_group(), setup_orb_toggle(), show_ally_, show_disengaged_, show_enemy_, show_moved_, show_partial_, show_unmoved_, and preferences::unmoved_color().

◆ reset_orb_callback()

void gui2::dialogs::select_orb_colors::reset_orb_callback ( )
private

◆ reset_orb_group()

void gui2::dialogs::select_orb_colors::reset_orb_group ( const std::string &  base_id,
bool &  shown,
const std::string &  initial 
)
private

Definition at line 129 of file select_orb_colors.cpp.

References groups_, and reset_orb_toggle().

Referenced by reset_orb_callback().

◆ reset_orb_toggle()

void gui2::dialogs::select_orb_colors::reset_orb_toggle ( const std::string &  base_id,
bool &  shown 
)
private

◆ setup_orb_group()

void gui2::dialogs::select_orb_colors::setup_orb_group ( const std::string &  base_id,
bool &  shown,
const std::string &  initial 
)
private

◆ setup_orb_toggle()

void gui2::dialogs::select_orb_colors::setup_orb_toggle ( const std::string &  base_id,
bool &  shown 
)
private

◆ toggle_orb_callback()

void gui2::dialogs::select_orb_colors::toggle_orb_callback ( bool &  storage)
private

Definition at line 135 of file select_orb_colors.cpp.

Referenced by setup_orb_toggle().

◆ window_id()

virtual const std::string& gui2::dialogs::select_orb_colors::window_id ( ) const
overrideprivatevirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ groups_

std::map<std::string, group<std::string> > gui2::dialogs::select_orb_colors::groups_
private

Definition at line 52 of file select_orb_colors.hpp.

Referenced by post_show(), reset_orb_group(), and setup_orb_group().

◆ show_ally_

bool gui2::dialogs::select_orb_colors::show_ally_
private

Definition at line 49 of file select_orb_colors.hpp.

Referenced by post_show(), pre_show(), and reset_orb_callback().

◆ show_disengaged_

bool gui2::dialogs::select_orb_colors::show_disengaged_
private

Definition at line 47 of file select_orb_colors.hpp.

Referenced by post_show(), pre_show(), and reset_orb_callback().

◆ show_enemy_

bool gui2::dialogs::select_orb_colors::show_enemy_
private

Definition at line 50 of file select_orb_colors.hpp.

Referenced by post_show(), pre_show(), and reset_orb_callback().

◆ show_moved_

bool gui2::dialogs::select_orb_colors::show_moved_
private

Definition at line 48 of file select_orb_colors.hpp.

Referenced by post_show(), pre_show(), and reset_orb_callback().

◆ show_partial_

bool gui2::dialogs::select_orb_colors::show_partial_
private

Definition at line 46 of file select_orb_colors.hpp.

Referenced by post_show(), pre_show(), and reset_orb_callback().

◆ show_unmoved_

bool gui2::dialogs::select_orb_colors::show_unmoved_
private

Definition at line 45 of file select_orb_colors.hpp.

Referenced by post_show(), pre_show(), and reset_orb_callback().


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