TGUI  0.9.2
tgui::GuiSDL Class Reference

Gui class for the SDL backend. More...

#include <TGUI/Backends/SDL/GuiSDL.hpp>

Inheritance diagram for tgui::GuiSDL:
tgui::GuiBase

Public Member Functions

 GuiSDL ()
 Default constructor. More...
 
 GuiSDL (SDL_Window *window)
 Constructs the gui and set the window on which the gui should be drawn. More...
 
void setWindow (SDL_Window *window)
 Sets the window on which the gui should be drawn. More...
 
bool handleEvent (const SDL_Event &event)
 Passes the event to the widgets. More...
 
void draw () override
 Draws all the widgets that were added to the gui.
 
void mainLoop () override
 Give the gui control over the main loop. More...
 
bool convertEvent (const SDL_Event &eventSDL, Event &eventTGUI)
 Helper function that converts an SDL event to a TGUI event. More...
 
bool handleEvent (Event event)
 Passes the event to the widgets. More...
 
- Public Member Functions inherited from tgui::GuiBase
void setAbsoluteViewport (const FloatRect &viewport)
 Sets the part of the screen to which the gui will render in pixels. More...
 
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. More...
 
RelFloatRect getViewport () const
 Returns to which part of the screen the gui will render. More...
 
void setAbsoluteView (const FloatRect &view)
 Sets the part of the gui that will be used to fill the viewport in pixels. More...
 
void setRelativeView (const FloatRect &view)
 Sets the part of the gui that will be used to fill the viewport. More...
 
RelFloatRect getView () const
 Returns the part of the gui that will be used to fill the viewport. More...
 
bool handleEvent (Event event)
 Passes the event to the widgets. More...
 
void setTabKeyUsageEnabled (bool enabled)
 When the tab key usage is enabled, pressing tab will focus another widget.
 
bool isTabKeyUsageEnabled () const
 Returns whether the tab key usage is enabled (if so, pressing tab will focus another widget)
 
RootContainer::Ptr getContainer () const
 Returns the internal container of the Gui. More...
 
void setFont (const Font &font)
 Changes the global font. More...
 
Font getFont () const
 Returns the global font for this gui. More...
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets. More...
 
void add (const Widget::Ptr &widgetPtr, const String &widgetName="")
 Adds a widget to the container. More...
 
Widget::Ptr get (const String &widgetName) const
 Returns a pointer to an earlier created widget. More...
 
template<class T >
T::Ptr get (const String &widgetName) const
 Returns a pointer to an earlier created widget. More...
 
bool remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
void removeAllWidgets ()
 Removes all widgets that were added to the container.
 
Widget::Ptr getFocusedChild () const
 Returns the child widget that is focused inside this container. More...
 
Widget::Ptr getFocusedLeaf () const
 Returns the leaf child widget that is focused inside this container. More...
 
Widget::Ptr getWidgetAtPosition (Vector2f pos) const
 Returns the leaf child widget that is located at the given position. More...
 
Widget::Ptr getWidgetBelowMouseCursor (Vector2i mousePos) const
 Returns the leaf child widget below the mouse. More...
 
bool focusNextWidget (bool recursive=true)
 Focuses the next widget in the gui. More...
 
bool focusPreviousWidget (bool recursive=true)
 Focuses the previous widget in the gui. More...
 
void unfocusAllWidgets ()
 Unfocus all the widgets.
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets, to the front of the z-order. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets, to the back of the z-order. More...
 
std::size_t moveWidgetForward (const Widget::Ptr &widget)
 Places a widget one step forward in the z-order. More...
 
std::size_t moveWidgetBackward (const Widget::Ptr &widget)
 Places a widget one step backward in the z-order. More...
 
bool setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
 Changes the index of a widget in this container. More...
 
int getWidgetIndex (const Widget::Ptr &widget) const
 Returns the current index of a widget in this container. More...
 
void setOpacity (float opacity)
 Changes the opacity of all widgets. More...
 
float getOpacity () const
 Returns the opacity of all the widgets. More...
 
void setTextSize (unsigned int size)
 Changes the character size of all existing and future child widgets. More...
 
unsigned int getTextSize () const
 Returns the character size for future child widgets (and for existing widgets where the size wasn't changed) More...
 
void loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const String &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream) const
 Saves this the child widgets to a text file. More...
 
void setOverrideMouseCursor (Cursor::Type type)
 Overrides which cursor gets shown. More...
 
void restoreOverrideMouseCursor ()
 Undoes the effect of the last call to setOverrideCursor. More...
 
void requestMouseCursor (Cursor::Type type)
 Function that is used by widgets to change the mouse cursor. More...
 
void setDrawingUpdatesTime (bool drawUpdatesTime)
 Sets whether drawing the gui will automatically update the internal clock or whether the user does it manually. More...
 
bool updateTime ()
 Updates the internal clock (for timers, animations and blinking edit cursors) More...
 

Additional Inherited Members

- Public Attributes inherited from tgui::GuiBase
SignalFloatRect onViewChange = {"ViewChanged"}
 The view was changed. Optional parameter: new view rectangle.
 

Detailed Description

Gui class for the SDL backend.

Constructor & Destructor Documentation

◆ GuiSDL() [1/2]

tgui::GuiSDL::GuiSDL ( )

Default constructor.

Warning
If you use this constructor then you will still have to call setWindow before using the gui.

◆ GuiSDL() [2/2]

tgui::GuiSDL::GuiSDL ( SDL_Window *  window)

Constructs the gui and set the window on which the gui should be drawn.

Parameters
windowThe SDL window that will be used by the gui

If you use this constructor then you will no longer have to call setWindow yourself.

Member Function Documentation

◆ convertEvent()

bool tgui::GuiSDL::convertEvent ( const SDL_Event &  eventSDL,
Event eventTGUI 
)

Helper function that converts an SDL event to a TGUI event.

Parameters
eventSFMLThe input SDL event
eventTGUIThe output TGUI event
Returns
Did the SDL event match on a TGUI event and has the output event been written to?

You typically don't need this function as you can call handleEvent directly with an SDL_Event.

◆ handleEvent() [1/2]

bool tgui::GuiSDL::handleEvent ( const SDL_Event &  event)

Passes the event to the widgets.

Parameters
eventThe event that was polled from the window
Returns
Has the event been consumed? When this function returns false, then the event was ignored by all widgets.

You should call this function in your event loop.

SDL_Event event;
while (SDL_PollEvent(&event) != 0) {
gui.handleEvent(event);
}

◆ handleEvent() [2/2]

bool tgui::GuiBase::handleEvent ( Event  event)

Passes the event to the widgets.

Parameters
eventThe event that was polled from the window
Returns
Has the event been consumed? When this function returns false, then the event was ignored by all widgets.

◆ mainLoop()

void tgui::GuiSDL::mainLoop ( )
overridevirtual

Give the gui control over the main loop.

This function is only intended in cases where your program only needs to respond to gui events. For multimedia applications, games, or other programs where you want a high framerate or do a lot of processing in the main loop, you should use your own main loop.

You can consider this function to execute something similar (but not identical) to the following code:

while (!quit)
{
SDL_Event event;
while (SDL_PollEvent(&event) != 0)
{
gui.handleEvent(event);
if (e.type == SDL_QUIT)
quit = true;
}
glClear(GL_COLOR_BUFFER_BIT);
gui.draw();
SDL_GL_SwapWindow(window);
}

Implements tgui::GuiBase.

◆ setWindow()

void tgui::GuiSDL::setWindow ( SDL_Window *  window)

Sets the window on which the gui should be drawn.

Parameters
windowThe SDL window that will be used by the gui

The documentation for this class was generated from the following file: