TGUI  1.2.0
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
26#ifndef TGUI_BACKEND_GUI_HPP
27#define TGUI_BACKEND_GUI_HPP
28
29#include <TGUI/Container.hpp>
30#include <TGUI/RelFloatRect.hpp>
31#include <TGUI/Event.hpp>
32#include <TGUI/Cursor.hpp>
33#include <TGUI/TwoFingerScrollDetect.hpp>
34
35#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
36 #include <chrono>
37 #include <stack>
38#endif
39
41
42TGUI_MODULE_EXPORT namespace tgui
43{
47 class TGUI_API BackendGui
48 {
49 public:
50
55
57 // Deleted copy constructor
59 BackendGui(const BackendGui& copy) = delete;
60
62 // Deleted assignment operator overload
64 BackendGui& operator=(const BackendGui& right) = delete;
65
67 // Virtual destructor
69 virtual ~BackendGui();
70
71
82 void setAbsoluteViewport(const FloatRect& viewport);
83
84
97 void setRelativeViewport(const FloatRect& viewport);
98
99
106 TGUI_NODISCARD RelFloatRect getViewport() const;
107
108
122 void setAbsoluteView(const FloatRect& view);
123
124
137 void setRelativeView(const FloatRect& view);
138
139
146 TGUI_NODISCARD RelFloatRect getView() const;
147
148
157 bool handleEvent(Event event);
158
159
163 void setTabKeyUsageEnabled(bool enabled);
164
165
169 TGUI_NODISCARD bool isTabKeyUsageEnabled() const;
170
171
175 virtual void draw();
176
177
189 TGUI_NODISCARD RootContainer::Ptr getContainer() const;
190
191
197 TGUI_NODISCARD std::shared_ptr<BackendRenderTarget> getBackendRenderTarget() const;
198
199
206 void setFont(const Font& font);
207
208
214 TGUI_NODISCARD Font getFont() const;
215
216
223 TGUI_NODISCARD const std::vector<Widget::Ptr>& getWidgets() const;
224
225
238 void add(const Widget::Ptr& widgetPtr, const String& widgetName = "");
239
240
254 TGUI_NODISCARD Widget::Ptr get(const String& widgetName) const;
255
256
271 template <class WidgetType>
272 TGUI_NODISCARD typename WidgetType::Ptr get(const String& widgetName) const
273 {
274 return m_container->get<WidgetType>(widgetName);
275 }
276
277
284 bool remove(const Widget::Ptr& widget);
285
286
292
293
302 TGUI_NODISCARD Widget::Ptr getFocusedChild() const;
303
304
313 TGUI_NODISCARD Widget::Ptr getFocusedLeaf() const;
314
315#ifndef TGUI_REMOVE_DEPRECATED_CODE
325 TGUI_DEPRECATED("Use getWidgetAtPos(pos, true) instead") TGUI_NODISCARD Widget::Ptr getWidgetAtPosition(Vector2f pos) const;
326#endif
327
342 TGUI_NODISCARD Widget::Ptr getWidgetAtPos(Vector2f pos, bool recursive) const;
343
344#ifndef TGUI_REMOVE_DEPRECATED_CODE
354 TGUI_DEPRECATED("Use getWidgetBelowMouseCursor(mousePos, true) instead") TGUI_NODISCARD Widget::Ptr getWidgetBelowMouseCursor(Vector2i mousePos) const;
355#endif
356
371 TGUI_NODISCARD Widget::Ptr getWidgetBelowMouseCursor(Vector2i mousePos, bool recursive) const;
372
373
382 bool focusNextWidget(bool recursive = true);
383
384
393 bool focusPreviousWidget(bool recursive = true);
394
395
400
401
407 void moveWidgetToFront(const Widget::Ptr& widget);
408
409
415 void moveWidgetToBack(const Widget::Ptr& widget);
416
417
428 std::size_t moveWidgetForward(const Widget::Ptr& widget);
429
430
441 std::size_t moveWidgetBackward(const Widget::Ptr& widget);
442
443
454 bool setWidgetIndex(const Widget::Ptr& widget, std::size_t index);
455
456
462 TGUI_NODISCARD int getWidgetIndex(const Widget::Ptr& widget) const;
463
464
471 void setOpacity(float opacity);
472
473
480 TGUI_NODISCARD float getOpacity() const;
481
482
491 void setTextSize(unsigned int size);
492
493
499 TGUI_NODISCARD unsigned int getTextSize() const;
500
501
508 void loadWidgetsFromFile(const String& filename, bool replaceExisting = true);
509
510
518 void saveWidgetsToFile(const String& filename);
519
520
527 void loadWidgetsFromStream(std::stringstream& stream, bool replaceExisting = true);
528
529
536 void loadWidgetsFromStream(std::stringstream&& stream, bool replaceExisting = true);
537
538
545 void saveWidgetsToStream(std::stringstream& stream) const;
546
547
560
561
569
570
582
583
589 void setDrawingUpdatesTime(bool drawUpdatesTime);
590
591
600
601
609 bool updateTime(Duration elapsedTime);
610
611
617 TGUI_NODISCARD Vector2f mapPixelToCoords(Vector2i pixel) const;
618
619
625 TGUI_NODISCARD Vector2f mapCoordsToPixel(Vector2f coord) const;
626
627
637 virtual void mainLoop(Color clearColor = {240, 240, 240}) = 0;
638
639
646 virtual void startTextInput(FloatRect inputRect);
647
648
653 virtual void stopTextInput();
654
655
663 virtual void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos);
664
665
680
681
691 TGUI_NODISCARD bool isKeyboardNavigationEnabled() const;
692
693
695 protected:
696
698 // Handles the backend-independent part of the two finger scrolling.
699 // Returns whether the touch event should be absorbed by the gui.
701 bool handleTwoFingerScroll(bool wasAlreadyScrolling);
702
704 // Updates the view and changes the size of the root container when needed.
705 // Derived classes should update m_framebufferSize in this function and then call this function from the base class.
707 virtual void updateContainerSize();
708
709
711 public:
712
713 SignalFloatRect onViewChange = {"ViewChanged"};
714
715
717 protected:
718
719 std::chrono::steady_clock::time_point m_lastUpdateTime;
720 bool m_windowFocused = true;
721
722 RootContainer::Ptr m_container = std::make_shared<RootContainer>();
723
724 Widget::Ptr m_visibleToolTip = nullptr;
725 Duration m_tooltipTime;
726 bool m_tooltipPossible = false;
727 Vector2f m_toolTipRelativePos;
728 Vector2i m_lastMousePos;
729 TwoFingerScrollDetect m_twoFingerScroll;
730
731 Vector2i m_framebufferSize;
732 RelFloatRect m_viewport{RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}};
733 RelFloatRect m_view{RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}};
734 FloatRect m_lastView;
735
736 bool m_drawUpdatesTime = true;
737 bool m_tabKeyUsageEnabled = true;
738 bool m_keyboardNavigationEnabled = false; // TGUI_NEXT: Enable by default?
739
740 Cursor::Type m_requestedMouseCursor = Cursor::Type::Arrow;
741 std::stack<Cursor::Type> m_overrideMouseCursors;
742
743 std::shared_ptr<BackendRenderTarget> m_backendRenderTarget = nullptr;
744 };
745
747}
748
750
751#endif // TGUI_BACKEND_GUI_HPP
Base class for the Gui.
Definition BackendGui.hpp:48
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:272
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:72
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
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