The Battle for Wesnoth  1.19.0-dev
edit_pbl_translation.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2023 - 2024
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #pragma once
16 
18 
19 namespace gui2
20 {
21 
22 namespace dialogs
23 {
24 
25 /**
26  * @ingroup GUIWindowDefinitionWML
27  *
28  * Dialog for adding a translation while editing an add-on's _server.pbl.
29  * Key |Type |Mandatory|Description
30  * ------------------|---------------|---------|-----------
31  * language | text_box |yes |The language code for this translation.
32  * lang_title | text_box |yes |The name of the language displayed on the UI.
33  * description | text_box |yes |The description of the translation.
34  */
36 {
37 public:
38  editor_edit_pbl_translation(std::string& language, std::string& title, std::string& description);
39 
40  /** The execute function. See @ref modal_dialog for more information. */
42 
43 private:
44  virtual void pre_show(window& window) override;
45  virtual void post_show(window& window) override;
46 
47  virtual const std::string& window_id() const override;
48 
49  std::string& language_;
50  std::string& title_;
51  std::string& description_;
52 };
53 
54 } // namespace dialogs
55 } // namespace gui2
Dialog for adding a translation while editing an add-on's _server.pbl.
virtual const std::string & window_id() const override
The ID of the window to build.
virtual void pre_show(window &window) override
The execute function.
editor_edit_pbl_translation(std::string &language, std::string &title, std::string &description)
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
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:63
#define DEFINE_SIMPLE_EXECUTE_WRAPPER(dialog)
Adds a bare-bonesstatic execute function to a dialog class that immediately invokes and return the re...
Various uncategorised dialogs.
Generic file dialog.
std::string language()
Definition: general.cpp:535