The Battle for Wesnoth  1.19.5+dev
unit_palette.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012 - 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 /**
17  * Manage the unit-palette in the editor.
18  */
19 
20 #pragma once
21 
23 
24 #include "units/types.hpp"
25 
26 namespace editor {
27 
28 class editor_toolkit;
29 
30 //std::string get_selected_terrain();
31 
32 /** Palette where the terrain to be drawn can be selected. */
33 class unit_palette : public editor_palette<const unit_type&> {
34 public:
35 
37 
38  virtual void setup(const game_config_view& cfg) override;
39 
40  virtual std::string get_help_string() const override;
41 
42  virtual bool supports_swap() override { return false; }
43 
44  const std::set<std::string>& get_selected_bg_items() { return selected_bg_items_; }
45 
46 private:
47  virtual const std::string& get_id(const unit_type& terrain) override;
48 
49  virtual void setup_item(
50  const unit_type& item,
51  texture& item_base_image,
52  texture& item_overlay_image,
53  std::stringstream& tooltip
54  ) override;
55 
56  virtual bool is_selected_bg_item(const std::string& id) override;
57 
58  virtual void select_bg_item(const std::string& item_id) override;
59 
60  std::set<std::string> selected_bg_items_;
61 
62 };
63 
64 }
Palette where the terrain to be drawn can be selected.
virtual void select_bg_item(const std::string &item_id) override
virtual void setup(const game_config_view &cfg) override
Setup the internal data structure.
virtual bool supports_swap() override
Whether the hotkey system should the enable GUI button connected to swap().
virtual const std::string & get_id(const unit_type &terrain) override
virtual bool is_selected_bg_item(const std::string &id) override
virtual std::string get_help_string() const override
virtual void setup_item(const unit_type &item, texture &item_base_image, texture &item_overlay_image, std::stringstream &tooltip) override
const std::set< std::string > & get_selected_bg_items()
std::set< std::string > selected_bg_items_
unit_palette(editor_display &gui, editor_toolkit &toolkit)
A class grating read only view to a vector of config objects, viewed as one config with all children ...
Wrapper class to encapsulate creation and management of an SDL_Texture.
Definition: texture.hpp:33
A single unit type that the player may recruit.
Definition: types.hpp:43
std::string tooltip
Shown when hovering over an entry in the filter's drop-down list.
Definition: manager.cpp:202
Manage the empty-palette in the editor.
Definition: action.cpp:31
General purpose widgets.