--- --- TGUI: include/TGUI/Backend/Window/BackendGui.hpp Source File
TGUI  1.x-dev
Loading...
Searching...
No Matches
BackendGui.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_HPP
26#define TGUI_BACKEND_GUI_HPP
27
28#include <TGUI/Container.hpp>
29#include <TGUI/RelFloatRect.hpp>
30#include <TGUI/Event.hpp>
31#include <TGUI/Cursor.hpp>
32#include <TGUI/TwoFingerScrollDetect.hpp>
33
34#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
35 #include <chrono>
36 #include <stack>
37#endif
38
40
41TGUI_MODULE_EXPORT namespace tgui
42{
46 class TGUI_API BackendGui
47 {
48 public:
49
54
56 // Deleted copy constructor
58 BackendGui(const BackendGui& copy) = delete;
59
61 // Deleted assignment operator overload
63 BackendGui& operator=(const BackendGui& right) = delete;
64
66 // Virtual destructor
68 virtual ~BackendGui();
69
80 void setAbsoluteViewport(const FloatRect& viewport);
81
94 void setRelativeViewport(const FloatRect& viewport);
95
102 TGUI_NODISCARD RelFloatRect getViewport() const;
103
117 void setAbsoluteView(const FloatRect& view);
118
131 void setRelativeView(const FloatRect& view);
132
139 TGUI_NODISCARD RelFloatRect getView() const;
140
149 bool handleEvent(Event event);
150
154 void setTabKeyUsageEnabled(bool enabled);
155
159 TGUI_NODISCARD bool isTabKeyUsageEnabled() const;
160
164 virtual void draw();
165
177 TGUI_NODISCARD RootContainer::Ptr getContainer() const;
178
184 TGUI_NODISCARD std::shared_ptr<BackendRenderTarget> getBackendRenderTarget() const;
185
192 void setFont(const Font& font);
193
199 TGUI_NODISCARD Font getFont() const;
200
207 TGUI_NODISCARD const std::vector<Widget::Ptr>& getWidgets() const;
208
221 void add(const Widget::Ptr& widgetPtr, const String& widgetName = "");
222
236 TGUI_NODISCARD Widget::Ptr get(const String& widgetName) const;
237
252 template <class WidgetType>
253 TGUI_NODISCARD typename WidgetType::Ptr get(const String& widgetName) const
254 {
255 return m_container->get<WidgetType>(widgetName);
256 }
257
264 bool remove(const Widget::Ptr& widget);
265
271
280 TGUI_NODISCARD Widget::Ptr getFocusedChild() const;
281
290 TGUI_NODISCARD Widget::Ptr getFocusedLeaf() const;
291
292#ifndef TGUI_REMOVE_DEPRECATED_CODE
302 TGUI_DEPRECATED("Use getWidgetAtPos(pos, true) instead") TGUI_NODISCARD Widget::Ptr getWidgetAtPosition(Vector2f pos) const;
303#endif
304
319 TGUI_NODISCARD Widget::Ptr getWidgetAtPos(Vector2f pos, bool recursive) const;
320
321#ifndef TGUI_REMOVE_DEPRECATED_CODE
331 TGUI_DEPRECATED("Use getWidgetBelowMouseCursor(mousePos, true) instead") TGUI_NODISCARD Widget::Ptr getWidgetBelowMouseCursor(Vector2i mousePos) const;
332#endif
333
348 TGUI_NODISCARD Widget::Ptr getWidgetBelowMouseCursor(Vector2i mousePos, bool recursive) const;
349
358 bool focusNextWidget(bool recursive = true);
359
368 bool focusPreviousWidget(bool recursive = true);
369
374
380 void moveWidgetToFront(const Widget::Ptr& widget);
381
387 void moveWidgetToBack(const Widget::Ptr& widget);
388
399 std::size_t moveWidgetForward(const Widget::Ptr& widget);
400
411 std::size_t moveWidgetBackward(const Widget::Ptr& widget);
412
423 bool setWidgetIndex(const Widget::Ptr& widget, std::size_t index);
424
430 TGUI_NODISCARD int getWidgetIndex(const Widget::Ptr& widget) const;
431
438 void setOpacity(float opacity);
439
446 TGUI_NODISCARD float getOpacity() const;
447
456 void setTextSize(unsigned int size);
457
463 TGUI_NODISCARD unsigned int getTextSize() const;
464
471 void loadWidgetsFromFile(const String& filename, bool replaceExisting = true);
472
480 void saveWidgetsToFile(const String& filename);
481
488 void loadWidgetsFromStream(std::stringstream& stream, bool replaceExisting = true);
489
496 void loadWidgetsFromStream(std::stringstream&& stream, bool replaceExisting = true);
497
504 void saveWidgetsToStream(std::stringstream& stream) const;
505
518
526
538
544 void setDrawingUpdatesTime(bool drawUpdatesTime);
545
554
562 bool updateTime(Duration elapsedTime);
563
569 TGUI_NODISCARD Vector2f mapPixelToCoords(Vector2i pixel) const;
570
576 TGUI_NODISCARD Vector2f mapCoordsToPixel(Vector2f coord) const;
577
587 virtual void mainLoop(Color clearColor = {240, 240, 240}) = 0;
588
595 virtual void startTextInput(FloatRect inputRect);
596
601 virtual void stopTextInput();
602
610 virtual void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos);
611
626
636 TGUI_NODISCARD bool isKeyboardNavigationEnabled() const;
637
639 protected:
640
642 // Handles the backend-independent part of the two finger scrolling.
643 // Returns whether the touch event should be absorbed by the gui.
645 bool handleTwoFingerScroll(bool wasAlreadyScrolling);
646
648 // Updates the view and changes the size of the root container when needed.
649 // Derived classes should update m_framebufferSize in this function and then call this function from the base class.
651 virtual void updateContainerSize();
652
654 public:
655
656 SignalFloatRect onViewChange = {"ViewChanged"};
657 Signal onWindowFocus = {"WindowFocused"};
658 Signal onWindowUnfocus = {"WindowUnfocused"};
659
661 protected:
662
663 std::chrono::steady_clock::time_point m_lastUpdateTime;
664 bool m_windowFocused = true;
665
666 RootContainer::Ptr m_container = std::make_shared<RootContainer>();
667
668 Widget::Ptr m_visibleToolTip = nullptr;
669 Duration m_tooltipTime;
670 bool m_tooltipPossible = false;
671 Vector2f m_toolTipRelativePos;
672 Vector2i m_lastMousePos;
673 TwoFingerScrollDetect m_twoFingerScroll;
674
675 Vector2i m_framebufferSize;
676 RelFloatRect m_viewport{RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}};
677 RelFloatRect m_view{RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}};
678 FloatRect m_lastView;
679
680 bool m_drawUpdatesTime = true;
681 bool m_tabKeyUsageEnabled = true;
682 bool m_keyboardNavigationEnabled = false; // TGUI_NEXT: Enable by default?
683
684 Cursor::Type m_requestedMouseCursor = Cursor::Type::Arrow;
685 std::stack<Cursor::Type> m_overrideMouseCursors;
686
687 std::shared_ptr<BackendRenderTarget> m_backendRenderTarget = nullptr;
688 };
689
691}
692
694
695#endif // TGUI_BACKEND_GUI_HPP
Base class for the Gui.
Definition BackendGui.hpp:47
TGUI_NODISCARD const std::vector< Widget::Ptr > & getWidgets() const
Returns a list of all the widgets.
void add(const Widget::Ptr &widgetPtr, const String &widgetName="")
Adds a widget to the container.
virtual void stopTextInput()
This function is called by TGUI when unfocusing a text field (EditBox or TextArea)....
std::size_t moveWidgetForward(const Widget::Ptr &widget)
Places a widget one step forward in the z-order.
TGUI_NODISCARD Widget::Ptr getWidgetAtPos(Vector2f pos, bool recursive) const
Returns the widget that is located at the given position.
void moveWidgetToBack(const Widget::Ptr &widget)
Places a widget behind all other widgets, to the back of the z-order.
void setFont(const Font &font)
Changes the global font.
void loadWidgetsFromFile(const String &filename, bool replaceExisting=true)
Loads the child widgets from a text file.
TGUI_NODISCARD WidgetType::Ptr get(const String &widgetName) const
Returns a pointer to an earlier created widget.
Definition BackendGui.hpp:253
TGUI_NODISCARD Font getFont() const
Returns the global font for this gui.
TGUI_NODISCARD RelFloatRect getViewport() const
Returns to which part of the screen the gui will render.
bool updateTime()
Updates the internal clock (for timers, animations and blinking edit cursors)
void setRelativeViewport(const FloatRect &viewport)
Sets the part of the screen to which the gui will render as a ratio relative to the window size.
void setAbsoluteView(const FloatRect &view)
Sets the part of the gui that will be used to fill the viewport in pixels.
virtual void startTextInput(FloatRect inputRect)
This function is called by TGUI when focusing a text field (EditBox or TextArea). It may result in th...
TGUI_NODISCARD Widget::Ptr getWidgetBelowMouseCursor(Vector2i mousePos, bool recursive) const
Returns the widget below the mouse.
TGUI_NODISCARD RootContainer::Ptr getContainer() const
Returns the internal container of the Gui.
virtual void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos)
This function is called by TGUI when the position of the caret changes in a text field (EditBox or Te...
virtual void mainLoop(Color clearColor={240, 240, 240})=0
Give the gui control over the main loop.
TGUI_NODISCARD int getWidgetIndex(const Widget::Ptr &widget) const
Returns the current index of a widget in this container.
TGUI_NODISCARD unsigned int getTextSize() const
Returns the character size for future child widgets (and for existing widgets where the size wasn't c...
void setAbsoluteViewport(const FloatRect &viewport)
Sets the part of the screen to which the gui will render in pixels.
TGUI_NODISCARD bool isKeyboardNavigationEnabled() const
Returns whether using the arrow keys can be used to navigate between widgets.
void loadWidgetsFromStream(std::stringstream &stream, bool replaceExisting=true)
Loads the child widgets from a string stream.
void saveWidgetsToStream(std::stringstream &stream) const
Saves this the child widgets to a text file.
std::size_t moveWidgetBackward(const Widget::Ptr &widget)
Places a widget one step backward in the z-order.
bool focusPreviousWidget(bool recursive=true)
Focuses the previous widget in the gui.
TGUI_NODISCARD RelFloatRect getView() const
Returns the part of the gui that will be used to fill the viewport.
virtual void draw()
Draws all the widgets that were added to the gui.
void setOpacity(float opacity)
Changes the opacity of all widgets.
void restoreOverrideMouseCursor()
Undoes the effect of the last call to setOverrideCursor.
void removeAllWidgets()
Removes all widgets that were added to the container.
void setRelativeView(const FloatRect &view)
Sets the part of the gui that will be used to fill the viewport.
void moveWidgetToFront(const Widget::Ptr &widget)
Places a widget before all other widgets, to the front of the z-order.
void saveWidgetsToFile(const String &filename)
Saves the child widgets to a text file.
bool handleEvent(Event event)
Passes the event to the widgets.
bool focusNextWidget(bool recursive=true)
Focuses the next widget in the gui.
TGUI_NODISCARD Widget::Ptr get(const String &widgetName) const
Returns a pointer to an earlier created widget.
void unfocusAllWidgets()
Unfocus all the widgets.
void setDrawingUpdatesTime(bool drawUpdatesTime)
Sets whether drawing the gui will automatically update the internal clock or whether the user does it...
TGUI_NODISCARD Widget::Ptr getFocusedLeaf() const
Returns the leaf child widget that is focused inside this container.
TGUI_NODISCARD Widget::Ptr getFocusedChild() const
Returns the child widget that is focused inside this container.
TGUI_NODISCARD bool isTabKeyUsageEnabled() const
Returns whether the tab key usage is enabled (if so, pressing tab will focus another widget)
void setTabKeyUsageEnabled(bool enabled)
When the tab key usage is enabled, pressing tab will focus another widget.
bool setWidgetIndex(const Widget::Ptr &widget, std::size_t index)
Changes the index of a widget in this container.
TGUI_NODISCARD std::shared_ptr< BackendRenderTarget > getBackendRenderTarget() const
Returns the backend render target that is assigned to the gui.
TGUI_NODISCARD Vector2f mapPixelToCoords(Vector2i pixel) const
Converts the pixel coordinate to a position within the view.
TGUI_NODISCARD Vector2f mapCoordsToPixel(Vector2f coord) const
Converts a position within the view to the corresponding pixel coordinate.
TGUI_NODISCARD float getOpacity() const
Returns the opacity of all the widgets.
void setTextSize(unsigned int size)
Changes the character size of all existing and future child widgets.
bool remove(const Widget::Ptr &widget)
Removes a single widget that was added to the container.
void loadWidgetsFromStream(std::stringstream &&stream, bool replaceExisting=true)
Loads the child widgets from a string stream.
BackendGui()
Default constructor.
void setKeyboardNavigationEnabled(bool enabled)
Changes whether using the arrow keys can be used to navigate between widgets.
void setOverrideMouseCursor(Cursor::Type type)
Overrides which cursor gets shown.
void requestMouseCursor(Cursor::Type type)
Function that is used by widgets to change the mouse cursor.
Wrapper for colors.
Definition Color.hpp:74
Type
List of available cursors.
Definition Cursor.hpp:51
Wrapper for durations.
Definition Duration.hpp:56
Wrapper around the backend-specific font. All copies of the font will share the same internal font re...
Definition Font.hpp:61
std::shared_ptr< RootContainer > Ptr
Shared widget pointer.
Definition Container.hpp:665
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:62
Wrapper class to store strings.
Definition String.hpp:101
Definition TwoFingerScrollDetect.hpp:45
The parent class for every widget.
Definition Widget.hpp:84
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
Definition Event.hpp:39
FloatRect that can contain absolute values or values relative to the parent size.
Definition RelFloatRect.hpp:41
Helper class to create an AbsoluteOrRelativeValue object containing a relative value without using a ...
Definition AbsoluteOrRelativeValue.hpp:177