TGUI 1.11
Loading...
Searching...
No Matches
Global.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2025 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#ifndef TGUI_GLOBAL_HPP
26#define TGUI_GLOBAL_HPP
27
29
30#include <TGUI/Config.hpp>
31#include <TGUI/Exception.hpp>
32#include <TGUI/Duration.hpp>
33#include <TGUI/Font.hpp>
34#include <TGUI/String.hpp>
35#include <TGUI/Filesystem.hpp>
36
37#include <cstdint>
38#include <string>
39#include <memory>
40
41#ifdef TGUI_DEBUG
42 #include <iostream>
43#endif
44
46
48namespace tgui
49{
53#if defined(__cpp_lib_smart_ptr_for_overwrite) && (__cpp_lib_smart_ptr_for_overwrite >= 202002L)
54 template <typename T>
55 const auto MakeUniqueForOverwrite = std::make_unique_for_overwrite<T>;
56#else
57 template <typename T>
58 TGUI_NODISCARD std::unique_ptr<T> MakeUniqueForOverwrite(const std::size_t size)
59 {
60 return std::unique_ptr<T>(new typename std::remove_extent_t<T>[size]);
61 }
62#endif
63
67 template <typename T>
68 TGUI_NODISCARD constexpr const T& clamp(const T& v, const T& lo, const T& hi)
69 {
70 return (v < lo) ? lo : (hi < v) ? hi : v;
71 }
72
76 TGUI_API void setGlobalTextSize(unsigned int textSize);
77
81 TGUI_NODISCARD TGUI_API unsigned int getGlobalTextSize();
82
86 TGUI_API void setDoubleClickTime(Duration duration);
87
91 TGUI_NODISCARD TGUI_API Duration getDoubleClickTime();
92
100 TGUI_API void setResourcePath(const Filesystem::Path& path);
101
109 TGUI_API void setResourcePath(const String& path);
110
118 TGUI_NODISCARD TGUI_API const Filesystem::Path& getResourcePath();
119
123 TGUI_API void setEditCursorBlinkRate(Duration blinkRate);
124
128 TGUI_NODISCARD TGUI_API Duration getEditCursorBlinkRate();
129
140 TGUI_NODISCARD TGUI_API std::unique_ptr<std::uint8_t[]> readFileToMemory(const String& filename, std::size_t& fileSize);
141
150 TGUI_API bool writeFile(const String& filename, const std::stringstream& textToWrite);
151
160 TGUI_API bool writeFile(const String& filename, CharStringView textToWrite);
161
165 template <typename To, typename From>
166 To downcast(From& base)
167 {
168 TGUI_ASSERT(dynamic_cast<std::remove_reference_t<To>*>(&base), "Downcasting to wrong type");
169 return static_cast<To>(base);
170 }
171
175 template <typename To, typename From>
176 To downcast(From* base)
177 {
178 TGUI_ASSERT(dynamic_cast<To>(base), "Downcasting to wrong type");
179 return static_cast<To>(base);
180 }
181
185 template <typename To, typename From>
186 std::shared_ptr<To> downcast(std::shared_ptr<From> base)
187 {
188 TGUI_ASSERT(std::dynamic_pointer_cast<To>(base), "Downcasting to wrong type");
189 return std::static_pointer_cast<To>(base);
190 }
191
193}
194
196
197#endif // TGUI_GLOBAL_HPP
198
Wrapper for durations.
Definition Duration.hpp:53
Object to represent paths on a filesystem.
Definition Filesystem.hpp:56
Wrapper class to store strings.
Definition String.hpp:94
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:36
TGUI_API void setDoubleClickTime(Duration duration)
Sets the double-click time for the mouse.
TGUI_API const Filesystem::Path & getResourcePath()
Returns the resource path.
TGUI_API void setGlobalTextSize(unsigned int textSize)
Sets the default text size for all widgets created after calling the function.
TGUI_API void setEditCursorBlinkRate(Duration blinkRate)
Changes the blink rate of the cursor in edit fields such as EditBox and TextArea.
TGUI_API void setResourcePath(const Filesystem::Path &path)
Sets a new resource path.
constexpr const T & clamp(const T &v, const T &lo, const T &hi)
Clamps a value between two boundries. This function exists because std::clamp was only added with c++...
Definition Global.hpp:68
TGUI_API Duration getDoubleClickTime()
Retrieves the double-click time for the mouse.
TGUI_API std::unique_ptr< std::uint8_t[]> readFileToMemory(const String &filename, std::size_t &fileSize)
Opens a file and reads its contents into memory.
TGUI_API Duration getEditCursorBlinkRate()
Returns the blink rate of the cursor in edit fields such as EditBox and TextArea.
std::unique_ptr< T > MakeUniqueForOverwrite(const std::size_t size)
Create a unique_ptr containing an uninitialized array.
Definition Global.hpp:58
TGUI_API bool writeFile(const String &filename, const std::stringstream &textToWrite)
Opens a file and writes the given contents to it.
To downcast(From &base)
Cast from a reference of a base class to a reference of a derived class.
Definition Global.hpp:166
TGUI_API unsigned int getGlobalTextSize()
Retrieves the default text size used for all new widgets.