TGUI  0.8-dev
Font.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2018 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 
38 namespace tgui
39 {
41 
42  class TGUI_API Font
43  {
44  public:
45 
46  // Move constructor has to be explicitly declared since this class has a destructor
47  Font(const Font&) = default;
48  Font(Font&&) = default;
49  Font& operator=(const Font&) = default;
50  Font& operator=(Font&&) = default;
51 
52 
57  Font(std::nullptr_t = nullptr);
58 
59 
66  Font(const std::string& id);
67 
68 
75  Font(const char* id);
76 
77 
84  Font(const std::shared_ptr<sf::Font>& font);
85 
86 
93  Font(const sf::Font& font);
94 
95 
101  Font(const void* data, std::size_t sizeInBytes);
102 
103 
105  // Destructor
107  ~Font();
108 
109 
116  const std::string& getId() const;
117 
118 
125  std::shared_ptr<sf::Font> getFont() const;
126 
127 
134  operator std::shared_ptr<sf::Font>() const;
135 
136 
141  operator bool() const;
142 
143 
148  bool operator==(std::nullptr_t) const;
149 
150 
155  bool operator!=(std::nullptr_t) const;
156 
157 
161  bool operator==(const Font& right) const;
162 
163 
167  bool operator!=(const Font& right) const;
168 
169 
186  const sf::Glyph& getGlyph(std::uint32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) const;
187 
188 
203  float getKerning(std::uint32_t first, std::uint32_t second, unsigned int characterSize) const;
204 
205 
216  float getLineSpacing(unsigned int characterSize) const;
217 
218 
220  private:
221 
222  std::shared_ptr<sf::Font> m_font;
223  std::string m_id;
224  };
225 
227 }
228 
230 
231 #endif // TGUI_TEXTURE_HPP
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Definition: Font.hpp:42
TGUI_CONSTEXPR bool operator!=(const Vector2f &left, const Vector2f &right)
Overload of binary operator ==.
Definition: Vector2f.hpp:224
TGUI_CONSTEXPR bool operator==(const Vector2f &left, const Vector2f &right)
Overload of binary operator ==.
Definition: Vector2f.hpp:216