The Battle for Wesnoth  1.19.0-dev
image.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2024
3  by Mark de Wever <koraq@xs4all.nl>
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 
22 
23 namespace gui2
24 {
25 namespace implementation
26 {
27  struct builder_image;
28 }
29 
30 // ------------ WIDGET -----------{
31 
32 /**
33  * @ingroup GUIWidgetWML
34  *
35  * An image shows a static image.
36  *
37  * The label field of the widget is used as the name of file to show. The widget normally has no event interaction so only one state is defined:
38  * * state_enabled - the image is enabled.
39  */
40 class image : public styled_widget
41 {
42 public:
43  explicit image(const implementation::builder_image& builder);
44 
45  /**
46  * Wrapper for set_label.
47  *
48  * Some people considered this function missing and confusing so added
49  * this forward version.
50  *
51  * @param label The filename image to show.
52  */
53  void set_image(const t_string& label)
54  {
56  }
57 
58  /**
59  * Wrapper for label.
60  *
61  * Some people considered this function missing and confusing so added
62  * this forward version.
63  *
64  * @returns The filename of the image shown.
65  */
67  {
68  return get_label();
69  }
70 
71  virtual bool can_mouse_focus() const override { return !tooltip().empty(); }
72 
73  /***** ***** ***** ***** layout functions ***** ***** ***** *****/
74 
75 private:
76  /** See @ref widget::calculate_best_size. */
77  virtual point calculate_best_size() const override;
78 
79 public:
80  /***** ***** ***** ***** Inherited ***** ***** ***** *****/
81 
82  /** See @ref styled_widget::set_active. */
83  virtual void set_active(const bool active) override;
84 
85  /** See @ref styled_widget::get_active. */
86  virtual bool get_active() const override;
87 
88  /** See @ref styled_widget::get_state. */
89  virtual unsigned get_state() const override;
90 
91  /** See @ref widget::disable_click_dismiss. */
92  bool disable_click_dismiss() const override;
93 
94 private:
95  /**
96  * Possible states of the widget.
97  *
98  * Note the order of the states must be the same as defined in settings.hpp.
99  */
100  enum state_t {
102  };
103 
104 public:
105  /** Static type getter that does not rely on the widget being constructed. */
106  static const std::string& type();
107 
108 private:
109  /** Inherited from styled_widget, implemented by REGISTER_WIDGET. */
110  virtual const std::string& get_control_type() const override;
111 };
112 
113 // }---------- DEFINITION ---------{
114 
116 {
117  explicit image_definition(const config& cfg);
118 
120  {
121  explicit resolution(const config& cfg);
122  };
123 };
124 
125 // }---------- BUILDER -----------{
126 
127 namespace implementation
128 {
129 
131 {
132  explicit builder_image(const config& cfg);
133 
135 
136  virtual std::unique_ptr<widget> build() const override;
137 };
138 
139 } // namespace implementation
140 
141 // }------------ END --------------
142 
143 } // namespace gui2
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
t_string get_image() const
Wrapper for label.
Definition: image.hpp:66
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: image.cpp:77
virtual bool get_active() const override
See styled_widget::get_active.
Definition: image.cpp:82
virtual point calculate_best_size() const override
See widget::calculate_best_size.
Definition: image.cpp:43
bool disable_click_dismiss() const override
See widget::disable_click_dismiss.
Definition: image.cpp:92
image(const implementation::builder_image &builder)
Definition: image.cpp:38
virtual unsigned get_state() const override
See styled_widget::get_state.
Definition: image.cpp:87
virtual const std::string & get_control_type() const override
Inherited from styled_widget, implemented by REGISTER_WIDGET.
state_t
Possible states of the widget.
Definition: image.hpp:100
void set_image(const t_string &label)
Wrapper for set_label.
Definition: image.hpp:53
static const std::string & type()
Static type getter that does not rely on the widget being constructed.
virtual bool can_mouse_focus() const override
Whether the mouse move/click event go 'through' this widget.
Definition: image.hpp:71
A label displays text that can be wrapped but no scrollbars are provided.
Definition: label.hpp:56
Base class for all visible items.
const t_string & get_label() const
const t_string & tooltip() const
virtual void set_label(const t_string &text)
bool empty() const
Definition: tstring.hpp:187
Generic file dialog.
Functions to load and save images from/to disk.
Contains the implementation details for lexical_cast and shouldn't be used directly.
resolution(const config &cfg)
Definition: image.cpp:107
image_definition(const config &cfg)
Definition: image.cpp:99
virtual std::unique_ptr< widget > build() const override
Definition: image.cpp:123
builder_image(const config &cfg)
Definition: image.cpp:119
virtual std::unique_ptr< widget > build() const=0
Base class of a resolution, contains the common keys for a resolution.
Holds a 2D point.
Definition: point.hpp:25