The Battle for Wesnoth  1.19.0-dev
mouse_action_map_label.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2024
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 #pragma once
17 
18 #include "mouse_action.hpp"
20 
21 class CKey;
22 
23 namespace editor {
24 
25 /**
26  * Set map label action.
27  */
29 {
30 public:
32  : mouse_action(palette, key), click_(false), clicked_on_()
33  {
34  }
35 
36  std::unique_ptr<editor_action> click_left(editor_display& disp, int x, int y) override;
37 
38  /**
39  * Drags a label.
40  */
41  std::unique_ptr<editor_action> drag_left(editor_display& disp, int x, int y, bool& partial, editor_action* last_undo) override;
42 
43  /**
44  * Replaces the label under the mouse with the dragged label.
45  */
46  std::unique_ptr<editor_action> drag_end_left(editor_display& disp, int x, int y) override;
47 
48  /**
49  * Left click displays a dialog that is used for entering the label string.
50  */
51  std::unique_ptr<editor_action> up_left(editor_display& disp, int x, int y) override;
52 
53  std::unique_ptr<editor_action> click_right(editor_display& disp, int x, int y) override;
54 
55  /**
56  * Right click erases the label under the mouse.
57  */
58  std::unique_ptr<editor_action> up_right(editor_display& disp, int x, int y) override;
59 
60  virtual void set_mouse_overlay(editor_display& disp) override;
61 
62 private:
63  bool click_;
65 };
66 
67 } //end namespace editor
Class that keeps track of all the keys on the keyboard.
Definition: key.hpp:29
Base class for all editor actions.
Definition: action_base.hpp:42
std::unique_ptr< editor_action > drag_left(editor_display &disp, int x, int y, bool &partial, editor_action *last_undo) override
Drags a label.
mouse_action_map_label(const CKey &key, empty_palette &palette)
std::unique_ptr< editor_action > up_right(editor_display &disp, int x, int y) override
Right click erases the label under the mouse.
std::unique_ptr< editor_action > drag_end_left(editor_display &disp, int x, int y) override
Replaces the label under the mouse with the dragged label.
std::unique_ptr< editor_action > click_left(editor_display &disp, int x, int y) override
A click, possibly the beginning of a drag.
virtual void set_mouse_overlay(editor_display &disp) override
Set the mouse overlay for this action.
std::unique_ptr< editor_action > up_left(editor_display &disp, int x, int y) override
Left click displays a dialog that is used for entering the label string.
std::unique_ptr< editor_action > click_right(editor_display &disp, int x, int y) override
A click, possibly the beginning of a drag.
A mouse action receives events from the controller, and responds to them by creating an appropriate e...
std::vector< color_t > palette(const color_range &cr)
Creates a reference color palette from a color range.
Definition: color_range.cpp:85
Manage the empty-palette in the editor.
Definition: action.cpp:31
Encapsulates the map of the game.
Definition: location.hpp:38