TGUI  1.0-alpha
DefaultBackendWindow.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 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 <TGUI/Color.hpp>
31#include <memory>
32
34
35namespace tgui
36{
37 class BackendGui;
38 struct Event;
39
46 class TGUI_API DefaultBackendWindow
47 {
48 public:
49
60 static std::shared_ptr<DefaultBackendWindow> create(unsigned int width, unsigned int height, const String& title);
61
62
70 virtual BackendGui* getGui() const = 0;
71
72
81 virtual bool isOpen() const = 0;
82
83
88 virtual void close() = 0;
89
90
98 virtual bool pollEvent(Event& event) = 0;
99
100
104 virtual void draw() = 0;
105
106
110 virtual void mainLoop(Color clearColor = {240, 240, 240}) = 0;
111
112
118 virtual void setIcon(const String& filename) = 0;
119
120
122 protected:
123
125 // Default constructor
127 DefaultBackendWindow() = default;
128
130 // Virtual destructor
132 virtual ~DefaultBackendWindow() = default;
133 };
134
136}
137
139
140#endif // TGUI_DEFAULT_BACKEND_WINDOW_HPP
Base class for the Gui.
Definition: BackendGui.hpp:45
Wrapper for colors.
Definition: Color.hpp:63
This class abstracts the backend-specific window and gui creation code.
Definition: DefaultBackendWindow.hpp:47
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 draw()=0
Draws the gui to the window.
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:79
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Definition: Event.hpp:37