The Battle for Wesnoth  1.17.12+dev
helper.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2022
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 
18 #include "color.hpp"
19 #include "font/text.hpp"
20 
21 #include <pango/pango-layout.h>
22 
23 #include <cstdint>
24 #include <string>
25 #include <string_view>
26 
27 struct SDL_Rect;
28 struct point;
29 class t_string;
30 
31 namespace wfl
32 {
33 class map_formula_callable;
34 } // namespace wfl
35 
36 namespace gui2
37 {
38 /**
39  * Converts a color string to a color.
40  *
41  * @param color A color string see @ref GUIWidgetWML for more info.
42  *
43  * @returns The color.
44  */
45 color_t decode_color(const std::string& color);
46 
47 /**
48  * Converts a text alignment string to a text alignment.
49  *
50  * @param alignment An alignment string see @ref GUIWidgetWML for more info.
51  *
52  * @returns The text alignment.
53  */
54 PangoAlignment decode_text_alignment(const std::string& alignment);
55 
56 /**
57  * Converts a text alignment to its string representation.
58  *
59  * @param alignment An alignment.
60  *
61  * @returns An alignment string see @ref GUIWidgetWML for more info.
62  */
63 std::string encode_text_alignment(const PangoAlignment alignment);
64 
65 /**
66  * Converts a font style string to a font style.
67  *
68  * @param style A font style string see @ref GUIWidgetWML for more info.
69  *
70  * @returns The font style.
71  */
72 font::pango_text::FONT_STYLE decode_font_style(const std::string& style);
73 
74 /**
75  * Returns a default error message if a mandatory widget is omitted.
76  *
77  * @param id The id of the omitted widget.
78  * @returns The error message.
79  */
80 t_string missing_widget(const std::string& id);
81 
82 /**
83  * Gets a formula object with the screen size.
84  *
85  * @param variable A formula object in which the screen_width,
86  * screen_height, gamemap_width and
87  * gamemap_height variable will set to the
88  * current values of these in settings. It
89  * modifies the object send.
90  */
92 
93 /**
94  * Gets a formula object with the screen size.
95  *
96  * @returns Formula object with the screen_width,
97  * screen_height, gamemap_width and
98  * gamemap_height variable set to the current
99  * values of these in settings.
100  */
102 
103 /** Returns the current mouse position. */
105 
106 /**
107  * Returns a truncated version of the text.
108  *
109  * For debugging it's sometimes useful to get a part of the label of the
110  * widget. This function shows the first part.
111  *
112  * @param text The text to truncate.
113  *
114  * @returns The truncated text.
115  */
116 std::string_view debug_truncate(std::string_view text);
117 
118 } // namespace gui2
std::string encode_text_alignment(const PangoAlignment alignment)
Converts a text alignment to its string representation.
Definition: helper.cpp:75
PangoAlignment decode_text_alignment(const std::string &alignment)
Converts a text alignment string to a text alignment.
Definition: helper.cpp:60
void get_screen_size_variables(wfl::map_formula_callable &variable)
Gets a formula object with the screen size.
Definition: helper.cpp:96
Generic file dialog.
The basic class for representing 8-bit RGB or RGBA colour values.
Definition: color.hpp:58
std::string_view debug_truncate(std::string_view text)
Returns a truncated version of the text.
Definition: helper.cpp:119
Holds a 2D point.
Definition: point.hpp:24
point get_mouse_position()
Returns the current mouse position.
Definition: helper.cpp:114
Definition: contexts.hpp:44
font::pango_text::FONT_STYLE decode_font_style(const std::string &style)
Converts a font style string to a font style.
Definition: helper.cpp:34
t_string missing_widget(const std::string &id)
Returns a default error message if a mandatory widget is omitted.
Definition: helper.cpp:91
color_t decode_color(const std::string &color)
Converts a color string to a color.
Definition: helper.cpp:55