Namespace that contains all TGUI functions and classes. More...

Classes
class	AbsoluteOrRelativeValue
	Class to store the a value that is either a constant or a ratio. More...

struct	Any

class	BaseThemeLoader
	Base class for theme loader implementations. More...

class	BitmapButton
	Button widget with an image displayed next to the text (or centered in the button without text) More...

class	BoxLayout
	Abstract class for box layout containers. More...

class	BoxLayoutRatios
	Abstract class for box layout containers. More...

class	BoxLayoutRenderer

class	Button
	Button widget. More...

class	ButtonRenderer

class	Canvas

class	ChatBox

class	ChatBoxRenderer

class	CheckBox
	CheckBox widget. More...

class	ChildWindow
	Child window widget. More...

class	ChildWindowRenderer

class	ClickableWidget
	Clickable widget. More...

class	Clipboard

class	Clipping

class	Color
	Wrapper for colors. More...

class	ComboBox
	Combo box widget. More...

class	ComboBoxRenderer

class	Container
	Container widget. More...

class	CopiedSharedPtr

class	DataIO
	Parser and emitter for widget files.

class	DefaultThemeLoader
	Default implementation for theme loading. More...

class	Deserializer
	Deserializes a settable property. More...

class	EditBox
	Edit box widget. More...

class	EditBoxRenderer

class	Exception

class	FloatRect

class	Font

class	Grid

class	Group
	Group widget. More...

class	GroupRenderer

class	Gui
	Gui class. More...

class	GuiContainer

class	HorizontalLayout
	Container that automatically resizes children to fit the entire available space between children. More...

class	HorizontalWrap
	Container that automatically arranges children in lines, adding a new line when a horizontal line is full. More...

class	Knob
	Knob widget. More...

class	KnobRenderer

class	Label
	Label widget. More...

class	LabelRenderer

class	Layout
	Class to store the left, top, width or height of a widget. More...

class	Layout2d
	Class to store the position or size of a widget. More...

class	ListBox
	List box widget. More...

class	ListBoxRenderer

class	MenuBar
	Menu bar widget. More...

class	MenuBarRenderer

class	MessageBox
	Message box widget. More...

class	MessageBoxRenderer

class	ObjectConverter
	Implicit converter for settable properties. More...

class	Outline

class	Panel
	Group of widgets that has a background color and optional borders. More...

class	PanelRenderer

class	Picture
	Picture widget. More...

class	PictureRenderer

class	ProgressBar
	Progress bar widget. More...

class	ProgressBarRenderer

class	RadioButton
	Radio button widget. More...

class	RadioButtonGroup
	Can be used as parent of radio buttons so that different groups of radio buttons can be isolated. More...

class	RadioButtonRenderer

class	RangeSlider
	RangeSlider widget. More...

class	RangeSliderRenderer

struct	RelativeValue
	Helper class to create an AbsoluteOrRelativeValue object containing a relative value without using a string. More...

struct	RendererData
	Shared data used in renderer classes. More...

class	ScrollablePanel
	Group of widgets that has a background color and optional borders. More...

class	ScrollablePanelRenderer

class	Scrollbar
	Scrollbar widget. More...

class	ScrollbarChildWidget
	Wrapper around scrollbar to be used inside widgets that need a scrollbar. More...

class	ScrollbarRenderer

class	Serializer
	Serializes an settable property. More...

class	Signal
	Signal to which the user can subscribe to get callbacks from. More...

class	SignalAnimation
	Signal to which the user can subscribe to get callbacks from. More...

class	SignalChildWindow
	Signal to which the user can subscribe to get callbacks from. More...

class	SignalItem
	Signal to which the user can subscribe to get callbacks from. More...

class	SignalMenuItem
	Signal to which the user can subscribe to get callbacks from. More...

class	SignalRange
	Signal to which the user can subscribe to get callbacks from. More...

class	SignalWidgetBase
	Base class for Widget which provides functionality to connect signals based on their name. More...

class	Slider
	Slider widget. More...

class	SliderRenderer

class	SpinButton
	Spin button widget. More...

class	SpinButtonRenderer

class	Sprite

class	Tabs
	Tabs widget. More...

class	TabsRenderer

class	Text

class	TextBox
	Text box widget. More...

class	TextBoxRenderer

class	TextStyle
	Wrapper for text styles. More...

class	Texture

struct	TextureData

struct	TextureDataHolder

class	TextureManager

class	Theme
	This class can be used to manage the widget renderers. More...

class	ToolTip
	Interface to set the settings for the tool tips. More...

class	Vector2f

class	VerticalLayout
	Container that automatically resizes children to fit the entire available space between children. More...

class	Widget
	The parent class for every widget. More...

class	WidgetFactory

class	WidgetRenderer
	Base class for all renderer classes. More...

Enumerations
enum	ShowAnimationType { ShowAnimationType::Fade, ShowAnimationType::Scale, ShowAnimationType::SlideToRight, ShowAnimationType::SlideToLeft, ShowAnimationType::SlideToBottom, ShowAnimationType::SlideToTop, ShowAnimationType::SlideFromLeft = SlideToRight, ShowAnimationType::SlideFromRight = SlideToLeft, ShowAnimationType::SlideFromTop = SlideToBottom, ShowAnimationType::SlideFromBottom = SlideToTop }
	Type of animation to show/hide widget. More...

Functions
TGUI_API void	setGlobalTextSize (unsigned int textSize)
	Sets the default text size for all widgets created after calling the function.

TGUI_API unsigned int	getGlobalTextSize ()
	Retrieves the default text size used for all new widgets.

TGUI_API void	setGlobalFont (const Font &font)
	Sets the default font used by widgets.

TGUI_API Font	getGlobalFont ()
	Retrieves the default font used for all new widgets. More...

TGUI_API void	setDoubleClickTime (unsigned int milliseconds)
	Sets the double-click time for the mouse.

TGUI_API unsigned int	getDoubleClickTime ()
	Retrieves the double-click time for the mouse.

TGUI_API void	setResourcePath (const std::string &path)
	Sets a new resource path. More...

TGUI_API const std::string &	getResourcePath ()
	Returns the resource path. More...

TGUI_API Layout	operator- (Layout right)
	Unary minus operator for the Layout class.

TGUI_API Layout	operator+ (Layout left, Layout right)
	operator for the Layout class

TGUI_API Layout	operator- (Layout left, Layout right)
	operator for the Layout class

TGUI_API Layout	operator* (Layout left, Layout right)
	operator for the Layout class

TGUI_API Layout	operator/ (Layout left, Layout right)
	/ operator for the Layout class

TGUI_API Layout2d	operator- (Layout2d right)
	Unary minus operator for the Layout2d class.

TGUI_API Layout2d	operator+ (Layout2d left, Layout2d right)
	operator for the Layout2d class

TGUI_API Layout2d	operator- (Layout2d left, Layout2d right)
	operator for the Layout2d class

TGUI_API Layout2d	operator* (Layout2d left, const Layout &right)
	operator for the Layout2d class

TGUI_API Layout2d	operator* (const Layout &left, Layout2d right)
	operator for the Layout2d class

TGUI_API Layout2d	operator/ (Layout2d left, const Layout &right)
	/ operator for the Layout2d class

TGUI_CONSTEXPR Vector2f	operator- (const Vector2f &right)
	Overload of unary operator -.

TGUI_CONSTEXPR Vector2f &	operator+= (Vector2f &left, const Vector2f &right)
	Overload of binary operator +=.

TGUI_CONSTEXPR Vector2f &	operator-= (Vector2f &left, const Vector2f &right)
	Overload of binary operator -=.

TGUI_CONSTEXPR Vector2f	operator+ (const Vector2f &left, const Vector2f &right)
	Overload of binary operator +.

TGUI_CONSTEXPR Vector2f	operator- (const Vector2f &left, const Vector2f &right)
	Overload of binary operator -.

TGUI_CONSTEXPR Vector2f	operator* (const Vector2f &left, float right)
	Overload of binary operator *.

TGUI_CONSTEXPR Vector2f	operator* (float left, const Vector2f &right)
	Overload of binary operator *.

TGUI_CONSTEXPR Vector2f &	operator*= (Vector2f &left, float right)
	Overload of binary operator *=.

TGUI_CONSTEXPR Vector2f	operator/ (const Vector2f &left, float right)
	Overload of binary operator /.

TGUI_CONSTEXPR Vector2f &	operator/= (Vector2f &left, float right)
	Overload of binary operator /=.

TGUI_CONSTEXPR bool	operator== (const Vector2f &left, const Vector2f &right)
	Overload of binary operator ==.

TGUI_CONSTEXPR bool	operator!= (const Vector2f &left, const Vector2f &right)
	Overload of binary operator ==.

Detailed Description

Namespace that contains all TGUI functions and classes.

Enumeration Type Documentation

◆ ShowAnimationType

enum tgui::ShowAnimationType

strong

Type of animation to show/hide widget.

Enumerator
Fade	Fade widget in or out.
Scale	Shrink to the center of the widget to hide or grow from its center to show.
SlideToRight	Slide to the right to hide or from left to show.
SlideToLeft	Slide to the left to hide or from right to show.
SlideToBottom	Slide to the bottom to hide or from top to show.
SlideToTop	Slide to the top to hide or from bottom to show.
SlideFromLeft	Slide from left to show or to the right to hide.
SlideFromRight	Slide from right to show or to the left to hide.
SlideFromTop	Slide from top to show or to the bottom to hide.
SlideFromBottom	Slide from bottom to show or to the top to hide.

Function Documentation

◆ getGlobalFont()

TGUI_API Font tgui::getGlobalFont ( )

Retrieves the default font used for all new widgets.

This function will create the font if there was no global font yet.

◆ getResourcePath()

TGUI_API const std::string& tgui::getResourcePath ( )

Returns the resource path.

This pathname is placed in front of every filename that is used to load a resource.

Returns: The current resource path

◆ setResourcePath()

TGUI_API void tgui::setResourcePath ( const std::string & path )

Sets a new resource path.

This pathname is placed in front of every filename that is used to load a resource.

Parameters

path	New resource path

TGUI

Classes

Enumerations