The Battle for Wesnoth  1.17.0-dev
folder_create.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011 - 2021
3  by Iris Morelle <shadowm2006@gmail.com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
19 
20 namespace gui2::dialogs
21 {
22 
23 /**
24  * @ingroup GUIWindowDefinitionWML
25  *
26  * Dialog for providing the name of a new folder to create. Used by the file dialog.
27  * Key |Type |Mandatory|Description
28  * ------------------|--------------|---------|-----------
29  * name | text_box |yes |Input field for the new folder name.
30  */
32 {
33 public:
34  /**
35  * Constructor.
36  *
37  * @param [in, out] folder_name
38  * The parameter's usage is:
39  * - Input: A suggested folder name.
40  * - Output: The folder name the user actually
41  * entered if the dialog returns
42  * retval::OK; undefined otherwise.
43  */
44  folder_create(std::string& folder_name);
45 
46  /** The execute function; see @ref modal_dialog for more information. */
48 
49 private:
50  friend class bookmark_create;
51 
53 
54  /** Changes the dialog caption so it can be used for naming bookmarks. */
56  {
57  bookmark_mode_ = true;
58  return *this;
59  }
60 
61  virtual const std::string& window_id() const override;
62 
63  virtual void pre_show(window& window) override;
64 };
65 
67 {
68 public:
69  /** The execute function; see @ref modal_dialog for more information. */
70  static bool execute(std::string& bookmark_name)
71  {
72  return folder_create(bookmark_name).enable_bookmark_mode().show();
73  }
74 };
75 
76 } // namespace dialogs
static bool execute(std::string &bookmark_name)
The execute function; see modal_dialog for more information.
folder_create & enable_bookmark_mode()
Changes the dialog caption so it can be used for naming bookmarks.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
folder_create(std::string &folder_name)
Constructor.
virtual const std::string & window_id() const override
The id of the window to build.
Dialog for providing the name of a new folder to create.
Abstract base class for all modal dialogs.
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65