TGUI  0.9-dev
DefaultBackendWindow.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
26#ifndef TGUI_DEFAULT_BACKEND_WINDOW_HPP
27#define TGUI_DEFAULT_BACKEND_WINDOW_HPP
28
29#include <TGUI/String.hpp>
30#include <memory>
31
33
34namespace tgui
35{
36 class BackendGui;
37 struct Event;
38
45 class TGUI_API DefaultBackendWindow
46 {
47 public:
48
59 static std::shared_ptr<DefaultBackendWindow> create(unsigned int width, unsigned int height, const String& title);
60
61
69 virtual BackendGui* getGui() const = 0;
70
71
80 virtual bool isOpen() const = 0;
81
82
87 virtual void close() = 0;
88
89
97 virtual bool pollEvent(Event& event) = 0;
98
99
103 virtual void draw() = 0;
104
105
109 virtual void mainLoop() = 0;
110
111
117 virtual void setIcon(const String& filename) = 0;
118
119
121 protected:
122
124 // Default constructor
126 DefaultBackendWindow() = default;
127
129 // Virtual destructor
131 virtual ~DefaultBackendWindow() = default;
132 };
133
135}
136
138
139#endif // TGUI_DEFAULT_BACKEND_WINDOW_HPP
Base class for the Gui.
Definition: BackendGui.hpp:45
This class abstracts the backend-specific window and gui creation code.
Definition: DefaultBackendWindow.hpp:46
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 void mainLoop()=0
Pass control of the main loop to TGUI, if the backend supports it.
virtual void draw()=0
Draws the gui to the window.
virtual void close()=0
Closes the window.
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:79
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Definition: Event.hpp:37