TGUI  1.6.1
Loading...
Searching...
No Matches
BackendGuiSFML.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_BACKEND_GUI_SFML_HPP
26#define TGUI_BACKEND_GUI_SFML_HPP
27
28#include <TGUI/Config.hpp>
29#if !TGUI_BUILD_AS_CXX_MODULE
30 #include <TGUI/Backend/Window/BackendGui.hpp>
31#endif
32
33#include <SFML/Window.hpp>
34
36
37TGUI_MODULE_EXPORT namespace tgui
38{
40
41 class TGUI_API BackendGuiSFML : public BackendGui
42 {
43 public:
44
51
56
82 bool handleEvent(sf::Event event);
83 using BackendGui::handleEvent;
84
130 void mainLoop(Color clearColor = {240, 240, 240}) override;
131
140 TGUI_NODISCARD bool convertEvent(const sf::Event& eventSFML, Event& eventTGUI);
141
147 sf::Window* getWindow() const;
148
155 void startTextInput(FloatRect inputRect) override;
156
161 void stopTextInput() override;
162
172 void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;
173
181 TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override;
182
184 protected:
185
191 void setGuiWindow(sf::Window& window);
192
194 // Updates the view and changes the size of the root container when needed
196 void updateContainerSize() override;
197
199 protected:
200
201 sf::Window* m_window = nullptr;
202
203 bool m_modifierKeySystemPressed = false;
204 bool m_modifierKeyControlPressed = false;
205 bool m_modifierKeyShiftPressed = false;
206 bool m_modifierKeyAltPressed = false;
207
209 };
210}
211
213
214#endif // TGUI_BACKEND_GUI_SFML_HPP
Definition BackendGuiSFML.hpp:42
~BackendGuiSFML()
Destructor.
bool convertEvent(const sf::Event &eventSFML, Event &eventTGUI)
Helper function that converts an SFML event to a TGUI event.
void setGuiWindow(sf::Window &window)
Sets the window which the gui should use.
sf::Window * getWindow() const
Returns the window that was provided to the gui.
bool handleEvent(sf::Event event)
Passes the event to the widgets.
void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override
This function is called by TGUI when the position of the caret changes in a text field (EditBox or Te...
BackendGuiSFML()
Default constructor.
void mainLoop(Color clearColor={240, 240, 240}) override
Give the gui control over the main loop.
void startTextInput(FloatRect inputRect) override
This function is called by TGUI when focusing a text field (EditBox or TextArea). It will result in t...
void stopTextInput() override
This function is called by TGUI when unfocusing a text field (EditBox or TextArea)....
bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override
Checks the state for one of the modifier keys.
Base class for the Gui.
Definition BackendGui.hpp:47
Wrapper for colors.
Definition Color.hpp:73
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
Definition Event.hpp:38
KeyModifier
Modifiers keys.
Definition Event.hpp:157