TGUI  0.8.9
Font.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2020 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_FONT_HPP
27#define TGUI_FONT_HPP
28
29#include <TGUI/Config.hpp>
30#include <SFML/Graphics/Font.hpp>
31#include <cstdint>
32#include <string>
33#include <cstddef>
34#include <memory>
35
37
38namespace tgui
39{
41
42 class TGUI_API Font
43 {
44 public:
45
50 Font(std::nullptr_t = nullptr);
51
52
59 Font(const std::string& id);
60
61
68 Font(const char* id);
69
70
77 Font(const std::shared_ptr<sf::Font>& font);
78
79
86 Font(const sf::Font& font);
87
88
94 Font(const void* data, std::size_t sizeInBytes);
95
96
98 // @brief Copy constructor
100 Font(const Font& other);
101
103 // @brief Move constructor
105 Font(Font&& other);
106
108 // @brief Copy move assignment operator
110 Font& operator=(const Font& other);
111
113 // @brief Copy move assignment operator
115 Font& operator=(Font&& other);
116
118 // @brief Destructor
120 ~Font();
121
122
129 const std::string& getId() const;
130
131
138 std::shared_ptr<sf::Font> getFont() const;
139
140
147 operator std::shared_ptr<sf::Font>() const;
148
149
154 operator bool() const;
155
156
161 bool operator==(std::nullptr_t) const;
162
163
168 bool operator!=(std::nullptr_t) const;
169
170
174 bool operator==(const Font& right) const;
175
176
180 bool operator!=(const Font& right) const;
181
182
199 const sf::Glyph& getGlyph(std::uint32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) const;
200
201
216 float getKerning(std::uint32_t first, std::uint32_t second, unsigned int characterSize) const;
217
218
229 float getLineSpacing(unsigned int characterSize) const;
230
231
233 private:
234
235 std::shared_ptr<sf::Font> m_font;
236 std::string m_id;
237 };
238
240}
241
243
244#endif // TGUI_FONT_HPP
Definition: Font.hpp:43
const std::string & getId() const
Returns the id that was used to load the font.
bool operator==(std::nullptr_t) const
Compares the font with a nullptr.
float getLineSpacing(unsigned int characterSize) const
Returns the line spacing.
bool operator==(const Font &right) const
Compares the font with another one.
Font(const sf::Font &font)
Constructor to set a copy of your font.
float getKerning(std::uint32_t first, std::uint32_t second, unsigned int characterSize) const
Returns the kerning offset of two glyphs.
const sf::Glyph & getGlyph(std::uint32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness=0) const
Retrieve a glyph of the font.
bool operator!=(std::nullptr_t) const
Compares the font with a nullptr.
std::shared_ptr< sf::Font > getFont() const
Gets the underlying SFML font.
Font(const std::string &id)
Constructor to create the font from a string (filename by default)
Font(const std::shared_ptr< sf::Font > &font)
Constructor to share the font directly.
Font(std::nullptr_t=nullptr)
Default constructor which will set the font to nullptr.
Font(const void *data, std::size_t sizeInBytes)
Constructor to create the font from a byte array.
Font(const char *id)
Constructor to create the font from a string (filename by default)
bool operator!=(const Font &right) const
Compares the font with another one.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:37