TGUI  1.6.1
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#ifndef TGUI_DEFAULT_BACKEND_WINDOW_HPP
26#define TGUI_DEFAULT_BACKEND_WINDOW_HPP
27
28#include <TGUI/Config.hpp>
29#if !TGUI_BUILD_AS_CXX_MODULE
30 #include <TGUI/String.hpp>
31 #include <TGUI/Color.hpp>
32#endif
33
34#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
35 #include <memory>
36#endif
37
39
40TGUI_MODULE_EXPORT namespace tgui
41{
42#if !TGUI_BUILD_AS_CXX_MODULE
43 class BackendGui;
44 struct Event;
45#endif
46
53 class TGUI_API DefaultBackendWindow
54 {
55 public:
56
61
65 virtual ~DefaultBackendWindow() = default;
66
77 TGUI_NODISCARD static std::shared_ptr<DefaultBackendWindow> create(unsigned int width, unsigned int height, const String& title);
78
86 TGUI_NODISCARD virtual BackendGui* getGui() const = 0;
87
96 TGUI_NODISCARD virtual bool isOpen() const = 0;
97
102 virtual void close() = 0;
103
111 TGUI_NODISCARD virtual bool pollEvent(Event& event) = 0;
112
116 virtual void draw() = 0;
117
121 virtual void mainLoop(Color clearColor = {240, 240, 240}) = 0;
122
128 virtual void setIcon(const String& filename) = 0;
129 };
130
132}
133
135
136#endif // TGUI_DEFAULT_BACKEND_WINDOW_HPP
Base class for the Gui.
Definition BackendGui.hpp:47
Wrapper for colors.
Definition Color.hpp:73
This class abstracts the backend-specific window and gui creation code.
Definition DefaultBackendWindow.hpp:54
virtual void setIcon(const String &filename)=0
Changes the icon of the window.
virtual bool isOpen() const =0
Returns whether the window is still open.
virtual ~DefaultBackendWindow()=default
Virtual destructor.
virtual void draw()=0
Draws the gui to the window.
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.
virtual BackendGui * getGui() const =0
Returns the gui object that is created and destroyed by this class.
virtual bool pollEvent(Event &event)=0
Retrieves an event from the window if there is one.
static std::shared_ptr< DefaultBackendWindow > create(unsigned int width, unsigned int height, const String &title)
Creates the backend window and the gui.
Wrapper class to store strings.
Definition String.hpp:96
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
Definition Event.hpp:38