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

Dialog for editing gamemap labels. More...

#include <edit_label.hpp>

Inheritance diagram for gui2::dialogs::editor_edit_label:

Public Member Functions

 editor_edit_label (std::string &text, bool &immutable, bool &visible_fog, bool &visible_shroud, color_t &color, std::string &category)
 Constructor. More...
 
- 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

int load_color_component (uint8_t color_t::*component)
 
void save_color_component (uint8_t color_t::*component, const int value)
 
void register_color_component (std::string widget_id, uint8_t color_t::*component)
 
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...
 

Private Attributes

color_tcolor_store
 The execute function. More...
 

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

Dialog for editing gamemap labels.

Key Type MandatoryDescription
title label yes Dialog title label.
label text_box yes Input field for the map label.
team_only_toggle toggle_button yes Checkbox for whether to make the label visible to the player's team only or not.

Definition at line 33 of file edit_label.hpp.

Constructor & Destructor Documentation

◆ editor_edit_label()

gui2::dialogs::editor_edit_label::editor_edit_label ( std::string &  text,
bool &  immutable,
bool &  visible_fog,
bool &  visible_shroud,
color_t color,
std::string &  category 
)

Constructor.

Parameters
[in,out]textThe parameter's usage is:
  • Input: The initial value of the label.
  • Output: The label text the user entered if the dialog returns retval::OK undefined otherwise.
immutableSets immutable_toggle attribute.
visible_fogSets visible_fog_toggle attribute.
visible_shroudSets visible_shroud_toggle attribute.
colorSets slider color.
categorySets category attribute.

Definition at line 31 of file edit_label.cpp.

References color_t::b, color_t::g, and color_t::r.

Member Function Documentation

◆ load_color_component()

int gui2::dialogs::editor_edit_label::load_color_component ( uint8_t color_t::*  component)
private

Definition at line 61 of file edit_label.cpp.

References color_store.

Referenced by register_color_component().

◆ pre_show()

void gui2::dialogs::editor_edit_label::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 49 of file edit_label.cpp.

References gui2::window::add_to_tab_order().

◆ register_color_component()

void gui2::dialogs::editor_edit_label::register_color_component ( std::string  widget_id,
uint8_t color_t::*  component 
)
private

◆ save_color_component()

void gui2::dialogs::editor_edit_label::save_color_component ( uint8_t color_t::*  component,
const int  value 
)
private

Definition at line 65 of file edit_label.cpp.

References color_store.

Referenced by register_color_component().

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ color_store

color_t& gui2::dialogs::editor_edit_label::color_store
private

The execute function.

See modal_dialog for more information.

Definition at line 61 of file edit_label.hpp.

Referenced by load_color_component(), and save_color_component().


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