The Battle for Wesnoth  1.17.0-dev
action_label.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2021
3  by Fabian Mueller <fabianmueller5@gmx.de>
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 /**
17  * @file
18  * Editor action classes. Some important points:
19  * - This is a polymorphic hierarchy of classes, so actions are usually passed around
20  * as editor_action pointers
21  * - The pointers can, in general, be null. Always check for null before doing anything.
22  * The helper functions perform_ that take a pointer do that.
23  * - The perform() functions can throw when an error occurs. Use smart pointers if you
24  * need to ensure the pointer is deleted.
25  */
26 
27 #pragma once
28 
29 #include "color.hpp"
30 #include "editor/action/action.hpp"
31 #include "map/map.hpp"
32 
33 namespace editor
34 {
35 /**
36  * Set label action
37  */
39 {
40 public:
42  const std::string& text,
43  const std::string& team_name,
44  color_t color,
45  bool visible_fog,
46  bool visible_shroud,
47  bool immutable,
48  std::string category)
50  , text_(text)
51  , team_name_(team_name)
52  , category_(category)
53  , color_(color)
54  , visible_fog_(visible_fog)
55  , visible_shroud_(visible_shroud)
56  , immutable_(immutable)
57  {
58  }
59 
60  std::unique_ptr<editor_action> clone() const override;
61  std::unique_ptr<editor_action> perform(map_context& mc) const override;
62  void perform_without_undo(map_context& mc) const override;
63  const std::string& get_name() const override;
64 
65 protected:
66  const std::string text_;
67  const std::string team_name_;
68  const std::string category_;
69 
71 
74  bool immutable_;
75 };
76 
78 {
79 public:
82  {
83  }
84 
85  std::unique_ptr<editor_action> clone() const override;
86  std::unique_ptr<editor_action> perform(map_context& mc) const override;
87  void perform_without_undo(map_context& mc) const override;
88  const std::string& get_name() const override;
89 };
90 
91 } // end namespace editor
std::unique_ptr< editor_action > perform(map_context &mc) const override
Perform the action, returning an undo action that, when performed, shall reverse any effects of this ...
const std::string team_name_
std::unique_ptr< editor_action > clone() const override
Action cloning.
editor_action_label_delete(map_location loc)
Base class for actions which act on a specified location (and possibly on other locations that can be...
Definition: action.hpp:176
const std::string & get_name() const override
void perform_without_undo(map_context &mc) const override
Perform the action without creating an undo action.
const std::string category_
Editor action classes.
Manage the empty-palette in the editor.
Definition: action.cpp:30
Encapsulates the map of the game.
Definition: location.hpp:38
This class wraps around a map to provide a concise interface for the editor to work with...
Definition: map_context.hpp:60
editor_action_label(map_location loc, const std::string &text, const std::string &team_name, color_t color, bool visible_fog, bool visible_shroud, bool immutable, std::string category)