tgui Namespace Reference

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

Classes
class	BaseTheme
	Base class for the Theme classes. More...
class	BaseThemeLoader
	Base class for theme loader implementations. More...
class	Borders
class	BoxLayout
	Abstract class for box layout containers. More...
class	Button
	Button widget. More...
class	ButtonRenderer
struct	Callback
class	Canvas
class	ChatBox
class	ChatBoxRenderer
class	CheckBox
	CheckBox widget. More...
class	CheckBoxRenderer
class	ChildWindow
	Child window widget. More...
class	ChildWindowRenderer
class	ClickableWidget
	Clickable widget. More...
class	Clipboard
class	Clipping
class	Color
	Implicit converter for colors. More...
class	ComboBox
	Combo box widget. More...
class	ComboBoxRenderer
class	Container
	Container widget. More...
class	DataIO
	Parser and emitter for widget files.
class	DefaultThemeLoader
	Default implementation for theme loading. More...
class	Deserializer
	Deserialize an settable property. More...
class	EditBox
	Edit box widget. More...
class	EditBoxRenderer
class	Exception
class	Font
class	Grid
class	Gui
	Gui class. More...
class	GuiContainer
class	HorizontalLayout
	Container that automatically resizes children to fit the entire available space between children. 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	LayoutImpl
	Shared information between layouts.
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	Panel
	Panel widget. More...
class	PanelRenderer
class	Picture
	Picture widget. More...
class	ProgressBar
	Progress bar widget. More...
class	ProgressBarRenderer
class	RadioButton
	Radio button widget. More...
class	RadioButtonRenderer
class	Scrollbar
	Scrollbar widget. More...
class	ScrollbarRenderer
class	Serializer
	Serialize an settable property. More...
class	Signal
class	SignalWidgetBase
	Base class for widgets to enable signal handling. More...
class	Slider
	Slider widget. More...
class	SliderRenderer
class	SpinButton
	Spin button widget. More...
class	SpinButtonRenderer
class	Tab
	Tab widget. More...
class	TabRenderer
class	TextBox
	Text box widget. More...
class	TextBoxRenderer
class	Texture
struct	TextureData
struct	TextureDataHolder
class	TextureManager
class	Theme
	Default Theme class. More...
class	ToolTip
	Interface to set the settings for the tool tips. More...
class	Transformable
struct	TypeSet
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	WidgetBorders
	Parent class for every widget that has borders. More...
class	WidgetConverter
	Implicit converter for widgets returned by the load function of the theme. More...
class	WidgetLoader
	Class to load widgets from a text file. More...
class	WidgetPadding
	Parent class for every widget that has padding. More...
class	WidgetRenderer
	Base class for all renderer classes. More...
class	WidgetSaver
	Class to save widgets to a text file. More...

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

Functions
TGUI_API void	enableTabKeyUsage ()
	While tab key usage is enabled (default), pressing tab will focus another widget.
TGUI_API void	disableTabKeyUsage ()
	When disabling the tab key usage, pressing tab will no longer focus another widget.
TGUI_API void	setResourcePath (const std::string &path)
	Set a new resource path. More...
TGUI_API const std::string &	getResourcePath ()
	Return the resource path. More...
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 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 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 Layout	operator|| (Layout left, Layout right)
	|| operator for the Layout class
TGUI_API Layout	operator== (Layout2d left, Layout2d right)
	== operator for the Layout2d class
TGUI_API Layout	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, Layout2d right)
	operator for the Layout2d class
TGUI_API Layout2d	operator* (Layout2d left, Layout right)
	operator for the Layout2d class
TGUI_API Layout2d	operator/ (Layout2d left, Layout right)
	/ operator for the Layout2d class
TGUI_API Layout2d	operator% (Layout2d left, Layout right)
	% operator for the Layout2d class
TGUI_API Layout2d	operator* (Layout left, Layout2d right)
	operator for the Layout2d class
TGUI_API Layout	bindLeft (std::shared_ptr< Widget > widget)
	Bind to the x position of the widget.
TGUI_API Layout	bindTop (std::shared_ptr< Widget > widget)
	Bind to the y position of the widget.
TGUI_API Layout	bindWidth (std::shared_ptr< Widget > widget)
	Bind to the width of the widget.
TGUI_API Layout	bindHeight (std::shared_ptr< Widget > widget)
	Bind to the height of the widget.
TGUI_API Layout	bindRight (std::shared_ptr< Widget > widget)
	Bind to the right position of the widget.
TGUI_API Layout	bindBottom (std::shared_ptr< Widget > widget)
	Bind to the bottom of the widget.
TGUI_API Layout2d	bindPosition (std::shared_ptr< Widget > widget)
	Bind to the position of the widget.
TGUI_API Layout2d	bindSize (std::shared_ptr< Widget > widget)
	Bind to the size of the widget.
TGUI_API Layout	bindLeft (Gui &gui)
	Bind to the x position of the gui view.
TGUI_API Layout	bindTop (Gui &gui)
	Bind to the y position of the gui view.
TGUI_API Layout	bindWidth (Gui &gui)
	Bind to the width of the gui view.
TGUI_API Layout	bindHeight (Gui &gui)
	Bind to the height of the gui view.
TGUI_API Layout	bindRight (Gui &gui)
	Bind to the right position of the gui view.
TGUI_API Layout	bindBottom (Gui &gui)
	Bind to the bottom position of the gui view.
TGUI_API Layout2d	bindPosition (Gui &gui)
	Bind to the position of the gui view.
TGUI_API Layout2d	bindSize (Gui &gui)
	Bind to the size of the gui view.
TGUI_API Layout	bindMin (Layout value1, Layout value2)
	Bind to the minimum of two values.
TGUI_API Layout	bindMax (Layout value1, Layout value2)
	Bind to the maximum of two values.
TGUI_API Layout	bindRange (Layout minimum, Layout maximum, Layout value)
	Bind to a value that remains between the minimum and maximum.
TGUI_API Layout	bindIf (Layout condition, Layout trueExpr, Layout falseExpr)
	Bind conditionally to one of the two layouts.
TGUI_API Layout2d	bindIf (Layout condition, Layout2d trueExpr, Layout2d falseExpr)
	Bind conditionally to one of the two layouts.
TGUI_API Layout	bindStr (const std::string &expression)
	Bind a string for a layout (you can also just create the layout directly with the string)
TGUI_API Layout	bindStr (const char *expression)
	Bind a string for a layout (you can also just create the layout directly with the string)
TGUI_API Layout2d	bindStr2d (const std::string &expression)
	Bind a string for a layout (you can also just create the layout directly with the string)
TGUI_API Layout2d	bindStr2d (const char *expression)
	Bind a string for a layout (you can also just create the layout directly with the string)

Detailed Description

Namespace that contains all TGUI functions and classes.

Enumeration Type Documentation

ShowAnimationType

enum class 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

getResourcePath()

TGUI_API const std::string & tgui::getResourcePath

(

)

Return 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

)

Set 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