TGUI  0.9-dev
Global.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2021 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#include <cstdint>
37#include <string>
38#include <memory>
39
40#ifdef TGUI_DEBUG
41 #include <iostream>
42#endif
43
45
47namespace tgui
48{
52#if defined(__cpp_lib_smart_ptr_for_overwrite) && (__cpp_lib_smart_ptr_for_overwrite >= 202002L)
53 template <typename T>
54 const auto MakeUniqueForOverwrite = std::make_unique_for_overwrite<T>;
55#else
56 template <typename T>
57 std::unique_ptr<T> MakeUniqueForOverwrite(const std::size_t size)
58 {
59 return std::unique_ptr<T>(new typename std::remove_extent<T>::type[size]);
60 }
61#endif
62
63
67 TGUI_API void setGlobalTextSize(unsigned int textSize);
68
69
73 TGUI_API unsigned int getGlobalTextSize();
74
75
79 TGUI_API void setDoubleClickTime(Duration duration);
80
81
86
87
95 TGUI_API void setResourcePath(const Filesystem::Path& path);
96
97
105 TGUI_API void setResourcePath(const String& path);
106
107
116
117
121 TGUI_API void setEditCursorBlinkRate(Duration blinkRate);
122
123
128
129
140 TGUI_API std::unique_ptr<std::uint8_t[]> readFileToMemory(const String& filename, std::size_t& fileSize);
141
142
151 TGUI_API bool writeFile(const String& filename, std::stringstream& textToWrite);
152
153
162 TGUI_API bool writeFile(const String& filename, const CharStringView& textToWrite);
163
164
166}
167
169
170#endif // TGUI_GLOBAL_HPP
171
Wrapper for durations.
Definition: Duration.hpp:52
Object to represent paths on a filesystem.
Definition: Filesystem.hpp:56
Wrapper class to store strings.
Definition: String.hpp:79
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.
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:57
TGUI_API bool writeFile(const String &filename, std::stringstream &textToWrite)
Opens a file and writes the given contents to it.
TGUI_API unsigned int getGlobalTextSize()
Retrieves the default text size used for all new widgets.