Base class for the Gui. More...

#include <TGUI/GuiBase.hpp>

Inheritance diagram for tgui::GuiBase:

Public Member Functions
	GuiBase (const GuiBase &copy)=delete

GuiBase &	operator= (const GuiBase &right)=delete

void	setAbsoluteViewport (const FloatRect &viewport)
	Sets the part of the screen to which the gui will render in pixels.

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.

RelFloatRect	getViewport () const
	Returns to which part of the screen the gui will render.

void	setAbsoluteView (const FloatRect &view)
	Sets the part of the gui that will be used to fill the viewport in pixels.

void	setRelativeView (const FloatRect &view)
	Sets the part of the gui that will be used to fill the viewport.

RelFloatRect	getView () const
	Returns the part of the gui that will be used to fill the viewport.

bool	handleEvent (Event event)
	Passes the event to the widgets.

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)

virtual void	draw ()=0
	Draws all the widgets that were added to the gui.

RootContainer::Ptr	getContainer () const
	Returns the internal container of the Gui.

void	setFont (const Font &font)
	Changes the global font.

Font	getFont () const
	Returns the global font for this gui.

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.

Widget::Ptr	get (const String &widgetName) const
	Returns a pointer to an earlier created widget.

template<class T >
T::Ptr	get (const String &widgetName) const
	Returns a pointer to an earlier created widget.

bool	remove (const Widget::Ptr &widget)
	Removes a single widget that was added to the container.

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.

Widget::Ptr	getFocusedLeaf () const
	Returns the leaf child widget that is focused inside this container.

Widget::Ptr	getWidgetAtPosition (Vector2f pos) const
	Returns the leaf child widget that is located at the given position.

Widget::Ptr	getWidgetBelowMouseCursor (Vector2i mousePos) const
	Returns the leaf child widget below the mouse.

bool	focusNextWidget (bool recursive=true)
	Focuses the next widget in the gui.

bool	focusPreviousWidget (bool recursive=true)
	Focuses the previous widget in the gui.

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.

void	moveWidgetToBack (const Widget::Ptr &widget)
	Places a widget behind all other widgets, to the back of the z-order.

std::size_t	moveWidgetForward (const Widget::Ptr &widget)
	Places a widget one step forward in the z-order.

std::size_t	moveWidgetBackward (const Widget::Ptr &widget)
	Places a widget one step backward in the z-order.

bool	setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
	Changes the index of a widget in this container.

int	getWidgetIndex (const Widget::Ptr &widget) const
	Returns the current index of a widget in this container.

void	setOpacity (float opacity)
	Changes the opacity of all widgets.

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.

unsigned int	getTextSize () const
	Returns the character size for future child widgets (and for existing widgets where the size wasn't changed)

void	loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
	Loads the child widgets from a text file.

void	saveWidgetsToFile (const String &filename)
	Saves the child widgets to a text file.

void	loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
	Loads the child widgets from a string stream.

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.

void	setOverrideMouseCursor (Cursor::Type type)
	Overrides which cursor gets shown.

void	restoreOverrideMouseCursor ()
	Undoes the effect of the last call to setOverrideCursor.

void	requestMouseCursor (Cursor::Type type)
	Function that is used by widgets to change the mouse cursor.

void	setDrawingUpdatesTime (bool drawUpdatesTime)
	Sets whether drawing the gui will automatically update the internal clock or whether the user does it manually.

bool	updateTime ()
	Updates the internal clock (for timers, animations and blinking edit cursors)

bool	updateTime (Duration elapsedTime)

Vector2f	mapPixelToView (int x, int y) const

virtual void	mainLoop ()=0
	Give the gui control over the main loop.

Public Attributes
SignalFloatRect	onViewChange = {"ViewChanged"}
	The view was changed. Optional parameter: new view rectangle.

Protected Member Functions
virtual void	init ()

virtual void	updateContainerSize ()

Protected Attributes
std::chrono::steady_clock::time_point	m_lastUpdateTime

bool	m_windowFocused = true

RootContainer::Ptr	m_container = nullptr

Widget::Ptr	m_visibleToolTip = nullptr

Duration	m_tooltipTime

bool	m_tooltipPossible = false

Vector2f	m_toolTipRelativePos

Vector2f	m_lastMousePos

RelFloatRect	m_viewport {RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}}

RelFloatRect	m_view {RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}}

FloatRect	m_lastView

bool	m_drawUpdatesTime = true

bool	m_tabKeyUsageEnabled = true

Cursor::Type	m_requestedMouseCursor = Cursor::Type::Arrow

std::stack< Cursor::Type >	m_overrideMouseCursors

Detailed Description

Base class for the Gui.

Member Function Documentation

◆ add()

void tgui::GuiBase::add	(	const Widget::Ptr &	widgetPtr,
		const String &	widgetName = `""`
	)

Adds a widget to the container.

Parameters

widgetPtr	Pointer to the widget you would like to add
widgetName	If you want to access the widget later then you must do this with this name

Warning: The widget name should not contain whitespace

◆ draw()

virtual void tgui::GuiBase::draw ( )

pure virtual

Draws all the widgets that were added to the gui.

Implemented in tgui::GuiSDL, and tgui::GuiSFML.

◆ focusNextWidget()

bool tgui::GuiBase::focusNextWidget ( bool recursive = true )

Focuses the next widget in the gui.

Parameters

recursive If the focused widget is a container, should the next widget inside it be focused instead of focusing the sibling of the container?

Returns: Whether a new widget was focused

◆ focusPreviousWidget()

bool tgui::GuiBase::focusPreviousWidget ( bool recursive = true )

Focuses the previous widget in the gui.

Parameters

recursive If the focused widget is a container, should the next widget inside it be focused instead of focusing the sibling of the container?

Returns: Whether a new widget was focused

◆ get() [1/2]

Widget::Ptr tgui::GuiBase::get ( const String & widgetName ) const

Returns a pointer to an earlier created widget.

Parameters

widgetName The name that was given to the widget when it was added to the container

Returns: Pointer to the earlier created widget

The gui will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

Warning: This function will return nullptr when an unknown widget name was passed

◆ get() [2/2]

template<class T >

T::Ptr tgui::GuiBase::get ( const String & widgetName ) const

inline

Returns a pointer to an earlier created widget.

Parameters

widgetName The name that was given to the widget when it was added to the container

Returns: Pointer to the earlier created widget. The pointer will already be casted to the desired type

The gui will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

Warning: This function will return nullptr when an unknown widget name was passed

◆ getContainer()

RootContainer::Ptr tgui::GuiBase::getContainer ( ) const

Returns the internal container of the Gui.

This could be useful when having a function that should accept both the gui and e.g. a child window as parameter.

Warning: Not all functions in the Container class make sense for the Gui (which is the reason that the Gui does not inherit from Container), so calling some functions (e.g. setSize) on the container will have no effect.

Returns: Reference to the internal Container class

◆ getFocusedChild()

Widget::Ptr tgui::GuiBase::getFocusedChild ( ) const

Returns the child widget that is focused inside this container.

Returns: Focused child widget or nullptr if none of the widgets are currently focused

If the focused widget is a container then a pointer to that container is returned. If you want to know which widget is focused inside that container (recursively) then you should use the getFocusedLeaf() function.

◆ getFocusedLeaf()

Widget::Ptr tgui::GuiBase::getFocusedLeaf ( ) const

Returns the leaf child widget that is focused inside this container.

Returns: Focused leaf child widget or nullptr if none of the widgets are currently focused

If the focused widget is a container then the getFocusedLeaf() is recursively called on that container. If you want to limit the search to only direct children of this container then you should use the getFocusedChild() function.

◆ getFont()

Font tgui::GuiBase::getFont ( ) const

Returns the global font for this gui.

Returns: Font for widgets in the gui

◆ getOpacity()

float tgui::GuiBase::getOpacity ( ) const

Returns the opacity of all the widgets.

Returns: The opacity of the widgets. 0 means completely transparent, while 1 (default) means fully opaque

◆ getTextSize()

unsigned int tgui::GuiBase::getTextSize ( ) const

Returns the character size for future child widgets (and for existing widgets where the size wasn't changed)

Returns: The current text size or 0 when no size was explicitly set in this gui

◆ getView()

RelFloatRect tgui::GuiBase::getView ( ) const

Returns the part of the gui that will be used to fill the viewport.

Returns

By default the view will have the same size as the viewport.

◆ getViewport()

RelFloatRect tgui::GuiBase::getViewport ( ) const

Returns to which part of the screen the gui will render.

Returns: Rect of the window to which the gui will draw

By default the viewport will fill the entire screen.

◆ getWidgetAtPosition()

Widget::Ptr tgui::GuiBase::getWidgetAtPosition ( Vector2f pos ) const

Returns the leaf child widget that is located at the given position.

Parameters

pos	The location where the widget will be searched, relative to the gui view

Returns: Widget at the queried position, or nullptr when there is no widget at that location

See also: getWidgetBelowMouseCursor

◆ getWidgetBelowMouseCursor()

Widget::Ptr tgui::GuiBase::getWidgetBelowMouseCursor ( Vector2i mousePos ) const

Returns the leaf child widget below the mouse.

Parameters

mousePos Position of the mouse, in pixel coordinates, relative the the window

Returns: Widget below the mouse, or nullptr when the mouse isn't on top of any widgets

See also: getWidgetAtPosition

◆ getWidgetIndex()

int tgui::GuiBase::getWidgetIndex ( const Widget::Ptr & widget ) const

Returns the current index of a widget in this container.

Returns: Index of the widget, or -1 if the widget wasn't found in this container

◆ getWidgets()

const std::vector< Widget::Ptr > & tgui::GuiBase::getWidgets ( ) const

Returns a list of all the widgets.

Returns: Vector of all widget pointers

◆ handleEvent()

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

Passes the event to the widgets.

Parameters

event The 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.

◆ loadWidgetsFromFile()

void tgui::GuiBase::loadWidgetsFromFile	(	const String &	filename,
		bool	replaceExisting = `true`
	)

Loads the child widgets from a text file.

Parameters

filename	Filename of the widget file
replaceExisting	Remove existing widgets first if there are any

◆ loadWidgetsFromStream() [1/2]

void tgui::GuiBase::loadWidgetsFromStream	(	std::stringstream &&	stream,
		bool	replaceExisting = `true`
	)

Loads the child widgets from a string stream.

Parameters

stream	stringstream that contains the widget file
replaceExisting	Remove existing widgets first if there are any

◆ loadWidgetsFromStream() [2/2]

void tgui::GuiBase::loadWidgetsFromStream	(	std::stringstream &	stream,
		bool	replaceExisting = `true`
	)

Loads the child widgets from a string stream.

Parameters

stream	stringstream that contains the widget file
replaceExisting	Remove existing widgets first if there are any

◆ mainLoop()

virtual void tgui::GuiBase::mainLoop ( )

pure virtual

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.

Implemented in tgui::GuiSDL, and tgui::GuiSFML.

◆ moveWidgetBackward()

std::size_t tgui::GuiBase::moveWidgetBackward ( const Widget::Ptr & widget )

Places a widget one step backward in the z-order.

Parameters

widget The widget that should be moved one step backward

Returns: New index in the widgets list (one lower than the old index or the same if the widget was already at back), or getWidgets().size() if the widget was never added to this container.

See also: moveWidgetToBack

◆ moveWidgetForward()

std::size_t tgui::GuiBase::moveWidgetForward ( const Widget::Ptr & widget )

Places a widget one step forward in the z-order.

Parameters

widget The widget that should be moved one step forward

Returns: New index in the widgets list (one higher than the old index or the same if the widget was already in front), or getWidgets().size() if the widget was never added to this container.

See also: moveWidgetToFront

◆ moveWidgetToBack()

void tgui::GuiBase::moveWidgetToBack ( const Widget::Ptr & widget )

Places a widget behind all other widgets, to the back of the z-order.

Parameters

widget The widget that should be moved to the back

◆ moveWidgetToFront()

void tgui::GuiBase::moveWidgetToFront ( const Widget::Ptr & widget )

Places a widget before all other widgets, to the front of the z-order.

Parameters

widget The widget that should be moved to the front

◆ remove()

bool tgui::GuiBase::remove ( const Widget::Ptr & widget )

Removes a single widget that was added to the container.

Parameters

widget Pointer to the widget to remove

◆ requestMouseCursor()

void tgui::GuiBase::requestMouseCursor ( Cursor::Type type )

Function that is used by widgets to change the mouse cursor.

Parameters

type	The requested cursor

This function is used to change the mouse cursor when the mouse enters or leaves a widget. If you want to choose a cursor that doesn't get changed when moving the mouse then use setOverrideMouseCursor. If an override cursor is already set then this function won't be able to change the cursor. When all overrides are removed with restoreOverrideMouseCursor then the mouse cursor will be changed to what was last requested here.

◆ restoreOverrideMouseCursor()

void tgui::GuiBase::restoreOverrideMouseCursor ( )

Undoes the effect of the last call to setOverrideCursor.

This function has to be called for each call to setOverrideCursor. If the stack of overriden cursors becomes empty then widgets will be able to change the cursor again.

◆ saveWidgetsToFile()

void tgui::GuiBase::saveWidgetsToFile ( const String & filename )

Saves the child widgets to a text file.

Parameters

filename Filename of the widget file

Exceptions

Exception when file could not be opened for writing

◆ saveWidgetsToStream()

void tgui::GuiBase::saveWidgetsToStream ( std::stringstream & stream ) const

Saves this the child widgets to a text file.

Parameters

stream stringstream to which the widget file will be added

◆ setAbsoluteView()

void tgui::GuiBase::setAbsoluteView ( const FloatRect & view )

Sets the part of the gui that will be used to fill the viewport in pixels.

Parameters

view	Rect of the gui that will be stretched to fill the viewport

No stretching will occur when the view has the same size as the viewport (default).

Example code to use the contents of the gui container from top-left (200,100) to bottom-right (600, 400) and stetch it to fill the viewport (which equals the entire window by default):

gui.setAbsoluteView({200, 100, 400, 300});

◆ setAbsoluteViewport()

void tgui::GuiBase::setAbsoluteViewport ( const FloatRect & viewport )

Sets the part of the screen to which the gui will render in pixels.

Parameters

viewport Rect of the window to which the gui should draw

Example code to render the gui on only the right side of an 800x600 window:

gui.setAbsoluteViewport({400, 0, 400, 600});

◆ setDrawingUpdatesTime()

void tgui::GuiBase::setDrawingUpdatesTime ( bool drawUpdatesTime )

Sets whether drawing the gui will automatically update the internal clock or whether the user does it manually.

Parameters

drawUpdatesTime True if gui.draw() updates the clock (default), false if gui.updateTime() has to be called

◆ setFont()

void tgui::GuiBase::setFont ( const Font & font )

Changes the global font.

Parameters

font	Font to use

◆ setOpacity()

void tgui::GuiBase::setOpacity ( float opacity )

Changes the opacity of all widgets.

Parameters

opacity The opacity of the widgets. 0 means completely transparent, while 1 (default) means fully opaque

◆ setOverrideMouseCursor()

void tgui::GuiBase::setOverrideMouseCursor ( Cursor::Type type )

Overrides which cursor gets shown.

Parameters

type	Which cursor to show

Warning: You must call restoreOverrideCursor() for every call to setOverrideCursor.

Until restoreOverrideCursor is called, the cursor will no longer be changed by widgets. If setOverrideCursor is called multiple times, the cursors are stacked and calling restoreOverrideCursor will only pop the last added cursor from the stack.

◆ setRelativeView()

void tgui::GuiBase::setRelativeView ( const FloatRect & view )

Sets the part of the gui that will be used to fill the viewport.

Parameters

view	Rect of the gui that will be stretched to fill the viewport, relative to the viewport size

The default view is (0, 0, 1, 1) so that no scaling happens even when the viewport is changed.

Example code to zoom in on the gui and display everything at 2x the size:

gui.setRelativeView({0, 0, 0.5f, 0.5f});

◆ setRelativeViewport()

void tgui::GuiBase::setRelativeViewport ( const FloatRect & viewport )

Sets the part of the screen to which the gui will render as a ratio relative to the window size.

Parameters

viewport Rect of the window to which the gui should draw, relative to the window size

The default viewport is set to (0, 0, 1, 1) so that it fills the entire window.

Example code to render the gui on only the right side of window:

gui.setRelativeViewport({0.5f, 0, 0.5f, 1});

◆ setTextSize()

void tgui::GuiBase::setTextSize ( unsigned int size )

Changes the character size of all existing and future child widgets.

Parameters

size	The new text size

The text size specified in this function overrides the global text size property. By default, the gui does not pass any text size to the widgets and the widgets will use the global text size as default value.

◆ setWidgetIndex()

bool tgui::GuiBase::setWidgetIndex	(	const Widget::Ptr &	widget,
		std::size_t	index
	)

Changes the index of a widget in this container.

Widgets are drawn in the order of the list, so overlapping widgets with a higher index will appear on top of others.

Parameters

widget	Widget that is to be moved to a different index
index	New index of the widget, corresponding to the widget position after the widget has been moved

Returns: True when the index was changed, false if widget wasn't found in the container or index was too high

◆ updateTime()

bool tgui::GuiBase::updateTime ( )

Updates the internal clock (for timers, animations and blinking edit cursors)

Returns: True if the the contents of the screen changed, false if nothing changed

You do not need to call this function unless you set DrawingUpdatesTime to false (it is true by default).

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

include/TGUI/GuiBase.hpp

TGUI

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ draw()

◆ focusNextWidget()

◆ focusPreviousWidget()

◆ get() [1/2]

◆ get() [2/2]

◆ getContainer()

◆ getFocusedChild()

◆ getFocusedLeaf()

◆ getFont()

◆ getOpacity()

◆ getTextSize()

◆ getView()

◆ getViewport()

◆ getWidgetAtPosition()

◆ getWidgetBelowMouseCursor()

◆ getWidgetIndex()

◆ getWidgets()

◆ handleEvent()

◆ loadWidgetsFromFile()

◆ loadWidgetsFromStream() [1/2]

◆ loadWidgetsFromStream() [2/2]

◆ mainLoop()

◆ moveWidgetBackward()

◆ moveWidgetForward()

◆ moveWidgetToBack()

◆ moveWidgetToFront()

◆ remove()

◆ requestMouseCursor()

◆ restoreOverrideMouseCursor()

◆ saveWidgetsToFile()

◆ saveWidgetsToStream()

◆ setAbsoluteView()

◆ setAbsoluteViewport()

◆ setDrawingUpdatesTime()

◆ setFont()

◆ setOpacity()

◆ setOverrideMouseCursor()

◆ setRelativeView()

◆ setRelativeViewport()

◆ setTextSize()

◆ setWidgetIndex()

◆ updateTime()