The Battle for Wesnoth  1.17.0-dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::editor_edit_side Class Reference

Dialog for editing gamemap sides. More...

#include <edit_side.hpp>

Inheritance diagram for gui2::dialogs::editor_edit_side:

Public Member Functions

 editor_edit_side (editor::editor_team_info &info)
 
- 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

virtual void pre_show (window &window) override
 The execute function. More...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 
virtual const std::string & window_id () const override
 The id of the window to build. More...
 

Private Attributes

team::CONTROLLER & controller_
 
group< team::CONTROLLER > controller_group
 
team::SHARE_VISION & share_vision_
 
group< team::SHARE_VISION > vision_group
 

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 sides.

Key Type MandatoryDescription
title label yes Dialog title label.
label text_box yes Input field for the id.
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 39 of file edit_side.hpp.

Constructor & Destructor Documentation

◆ editor_edit_side()

gui2::dialogs::editor_edit_side::editor_edit_side ( editor::editor_team_info info)
explicit

Definition at line 31 of file edit_side.cpp.

References lg::info().

Member Function Documentation

◆ post_show()

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

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the OK has been pressed).

Parameters
windowThe window which has been shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 71 of file edit_side.cpp.

References controller_, controller_group, gui2::group< T >::get_active_member_value(), share_vision_, and vision_group.

◆ pre_show()

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

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ controller_

team::CONTROLLER& gui2::dialogs::editor_edit_side::controller_
private

Definition at line 51 of file edit_side.hpp.

Referenced by post_show(), and pre_show().

◆ controller_group

group<team::CONTROLLER> gui2::dialogs::editor_edit_side::controller_group
private

Definition at line 52 of file edit_side.hpp.

Referenced by post_show(), and pre_show().

◆ share_vision_

team::SHARE_VISION& gui2::dialogs::editor_edit_side::share_vision_
private

Definition at line 54 of file edit_side.hpp.

Referenced by post_show(), and pre_show().

◆ vision_group

group<team::SHARE_VISION> gui2::dialogs::editor_edit_side::vision_group
private

Definition at line 55 of file edit_side.hpp.

Referenced by post_show(), and pre_show().


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