TGUI  1.3-dev
Loading...
Searching...
No Matches
DefaultBackendWindow.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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_DEFAULT_BACKEND_WINDOW_HPP
27#define TGUI_DEFAULT_BACKEND_WINDOW_HPP
28
29#include <TGUI/Config.hpp>
30#if !TGUI_BUILD_AS_CXX_MODULE
31 #include <TGUI/String.hpp>
32 #include <TGUI/Color.hpp>
33#endif
34
35#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
36 #include <memory>
37#endif
38
40
41TGUI_MODULE_EXPORT namespace tgui
42{
43#if !TGUI_BUILD_AS_CXX_MODULE
44 class BackendGui;
45 struct Event;
46#endif
47
54 class TGUI_API DefaultBackendWindow
55 {
56 public:
57
62
66 virtual ~DefaultBackendWindow() = default;
67
68
79 TGUI_NODISCARD static std::shared_ptr<DefaultBackendWindow> create(unsigned int width, unsigned int height, const String& title);
80
81
89 TGUI_NODISCARD virtual BackendGui* getGui() const = 0;
90
91
100 TGUI_NODISCARD virtual bool isOpen() const = 0;
101
102
107 virtual void close() = 0;
108
109
117 TGUI_NODISCARD virtual bool pollEvent(Event& event) = 0;
118
119
123 virtual void draw() = 0;
124
125
129 virtual void mainLoop(Color clearColor = {240, 240, 240}) = 0;
130
131
137 virtual void setIcon(const String& filename) = 0;
138 };
139
141}
142
144
145#endif // TGUI_DEFAULT_BACKEND_WINDOW_HPP
Base class for the Gui.
Definition BackendGui.hpp:48
Wrapper for colors.
Definition Color.hpp:72
This class abstracts the backend-specific window and gui creation code.
Definition DefaultBackendWindow.hpp:55
virtual TGUI_NODISCARD bool isOpen() const =0
Returns whether the window is still open.
virtual void setIcon(const String &filename)=0
Changes the icon of the window.
virtual ~DefaultBackendWindow()=default
Virtual destructor.
virtual void draw()=0
Draws the gui to the window.
virtual TGUI_NODISCARD BackendGui * getGui() const =0
Returns the gui object that is created and destroyed by this class.
DefaultBackendWindow()=default
Default constructor.
virtual void close()=0
Closes the window.
virtual void mainLoop(Color clearColor={240, 240, 240})=0
Pass control of the main loop to TGUI, if the backend supports it.
static TGUI_NODISCARD std::shared_ptr< DefaultBackendWindow > create(unsigned int width, unsigned int height, const String &title)
Creates the backend window and the gui.
virtual TGUI_NODISCARD bool pollEvent(Event &event)=0
Retrieves an event from the window if there is one.
Wrapper class to store strings.
Definition String.hpp:101
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
Definition Event.hpp:39