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

#include <folder_create.hpp>

Inheritance diagram for gui2::dialogs::folder_create:
Inheritance graph

Public Member Functions

 folder_create (std::string &folder_name)
 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
 
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

folder_createenable_bookmark_mode ()
 Changes the dialog caption so it can be used for naming bookmarks. More...
 
virtual const std::string & window_id () const override
 Inherited from modal_dialog, implemented by REGISTER_DIALOG. More...
 
virtual void pre_show (window &window) override
 Inherited from modal_dialog. More...
 

Private Attributes

bool bookmark_mode_
 

Friends

class bookmark_create
 The execute function; see modal_dialog for more information. 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

Definition at line 24 of file folder_create.hpp.

Constructor & Destructor Documentation

◆ folder_create()

gui2::dialogs::folder_create::folder_create ( std::string &  folder_name)

Constructor.

Parameters
[in,out]folder_nameThe parameter's usage is:
  • Input: A suggested folder name.
  • Output: The folder name the user actually entered if the dialog returns retval::OK; undefined otherwise.

Definition at line 51 of file folder_create.cpp.

Referenced by gui2::dialogs::bookmark_create::execute().

Member Function Documentation

◆ enable_bookmark_mode()

folder_create& gui2::dialogs::folder_create::enable_bookmark_mode ( )
inlineprivate

Changes the dialog caption so it can be used for naming bookmarks.

Definition at line 48 of file folder_create.hpp.

References pre_show(), and window_id().

◆ pre_show()

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

Inherited from modal_dialog.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 57 of file folder_create.cpp.

References _(), and bookmark_mode_.

Referenced by enable_bookmark_mode().

◆ window_id()

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

Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Referenced by enable_bookmark_mode().

Friends And Related Function Documentation

◆ bookmark_create

friend class bookmark_create
friend

The execute function; see modal_dialog for more information.

Definition at line 43 of file folder_create.hpp.

Member Data Documentation

◆ bookmark_mode_

bool gui2::dialogs::folder_create::bookmark_mode_
private

Definition at line 45 of file folder_create.hpp.

Referenced by pre_show().


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