The Battle for Wesnoth  1.19.1+dev
folder_create.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011 - 2024
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 
24 {
25 public:
26  /**
27  * Constructor.
28  *
29  * @param [in, out] folder_name
30  * The parameter's usage is:
31  * - Input: A suggested folder name.
32  * - Output: The folder name the user actually
33  * entered if the dialog returns
34  * retval::OK; undefined otherwise.
35  */
36  folder_create(std::string& folder_name);
37 
38  /** The execute function; see @ref modal_dialog for more information. */
40 
41 private:
42  friend class bookmark_create;
43 
45 
46  /** Changes the dialog caption so it can be used for naming bookmarks. */
48  {
49  bookmark_mode_ = true;
50  return *this;
51  }
52 
53  virtual const std::string& window_id() const override;
54 
55  virtual void pre_show(window& window) override;
56 };
57 
59 {
60 public:
61  /** The execute function; see @ref modal_dialog for more information. */
62  static bool execute(std::string& bookmark_name)
63  {
64  return folder_create(bookmark_name).enable_bookmark_mode().show();
65  }
66 };
67 
68 } // namespace dialogs
static bool execute(std::string &bookmark_name)
The execute function; see modal_dialog for more information.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
virtual const std::string & window_id() const override
The ID of the window to build.
folder_create(std::string &folder_name)
Constructor.
folder_create & enable_bookmark_mode()
Changes the dialog caption so it can be used for naming bookmarks.
Abstract base class for all modal dialogs.
bool show(const unsigned auto_close_time=0)
Shows the window.
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:61
#define DEFINE_SIMPLE_EXECUTE_WRAPPER(dialog)
Adds a bare-bonesstatic execute function to a dialog class that immediately invokes and return the re...