#include <TGUI/Widgets/TabContainer.hpp>

Inheritance diagram for tgui::TabContainer:

Public Types
enum	TabAlign { Top = 0 , Bottom = 1 << 0 }
	Enumeration of the tab alignments for tabs. More...

using	Ptr = std::shared_ptr<TabContainer>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const TabContainer>
	Shared constant widget pointer.

Public Types inherited from tgui::Container
using	Ptr = std::shared_ptr<Container>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Container>
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
using	Ptr = std::shared_ptr<Widget>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Widget>
	Shared constant widget pointer.

Public Member Functions
	TabContainer (const char *typeName=StaticWidgetType, bool initRenderer=true)

	TabContainer (const TabContainer &copy)
	Copy constructor.

	TabContainer (TabContainer &&copy) noexcept
	Move constructor.

TabContainer &	operator= (const TabContainer &right)
	Overload of copy assignment operator.

TabContainer &	operator= (TabContainer &&right) noexcept
	Overload of move assignment operator.

TGUI_NODISCARD TabsRenderer *	getTabsSharedRenderer ()
	Returns the renderer of tabs part of widget.

TGUI_NODISCARD const TabsRenderer *	getTabsSharedRenderer () const

TGUI_NODISCARD TabsRenderer *	getTabsRenderer ()
	Returns the renderer of tabs part of widget.

void	setSize (const Layout2d &size) override
	Changes the size of the tab container.

void	setTabsHeight (const Layout &height)
	Changes the height of tabs part of the widget.

Panel::Ptr	addTab (const String &name, bool select=true)
	Adds a new tab and corresponding panel.

Panel::Ptr	insertTab (std::size_t index, const String &name, bool select=true)
	Inserts a new tab and panel somewhere between the existing ones.

bool	removeTab (const String &text)
	Removes a tab and its corresponding panel, given the text of the tab.

bool	removeTab (std::size_t index)
	Removes a tab and its corresponding panel with a given index.

void	select (std::size_t index)
	Sets selection to panel.

TGUI_NODISCARD std::size_t	getPanelCount () const
	Returns the number of holded panels.

TGUI_NODISCARD int	getIndex (const Panel::Ptr &panel)
	Returns index of the specified panel.

TGUI_NODISCARD Panel::Ptr	getSelected ()
	Returns the selected panel or nullptr.

TGUI_NODISCARD int	getSelectedIndex () const
	Returns index of the selected panel.

TGUI_NODISCARD Panel::Ptr	getPanel (int index)
	Returns the panel with given index.

TGUI_NODISCARD Tabs::Ptr	getTabs ()
	Returns internal tabs widget.

TGUI_NODISCARD String	getTabText (std::size_t index) const
	Gets the text of one of the tabs.

bool	changeTabText (std::size_t index, const String &text)
	Changes the text of one of the tabs.

void	setTabAlignment (TabContainer::TabAlign align)
	Changes the alignment of the tabs.

TGUI_NODISCARD TabContainer::TabAlign	getTabAlignment () const
	Returns the alignment of the tabs.

void	setTabFixedSize (float fixedSize)
	Changes the tab fixed size for fixed size alignment.

TGUI_NODISCARD float	getTabFixedSize () const
	Returns the tab fixed size for fixed size alignment, default is 0.0f.

TGUI_NODISCARD bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

void	setSize (const Layout2d &size) override
	Changes the size of the container.

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::Container
	Container (const char *typeName, bool initRenderer)

	Container (const Container &copy)
	Copy constructor.

	Container (Container &&copy) noexcept
	Move constructor.

	~Container () override
	Destructor.

Container &	operator= (const Container &right)
	Overload of copy assignment operator.

Container &	operator= (Container &&right) noexcept
	Overload of move assignment operator.

TGUI_NODISCARD const std::vector< Widget::Ptr > &	getWidgets () const
	Returns a list of all the widgets in this container.

template<typename Function >
void	sortWidgets (Function &&function)
	Sorts a list of all the widgets in this container.

virtual void	add (const Widget::Ptr &widgetPtr, const String &widgetName="")
	Adds a widget to the container.

TGUI_NODISCARD Widget::Ptr	get (const String &widgetName) const
	Returns a pointer to a widget that was added earlier.

template<class WidgetType >
TGUI_NODISCARD WidgetType::Ptr	get (const String &widgetName) const
	Returns a pointer to a widget that was added earlier.

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

virtual void	removeAllWidgets ()
	Removes all widgets that were added to the container.

virtual TGUI_NODISCARD Vector2f	getInnerSize () const
	Returns the space available for widgets inside the container.

virtual TGUI_NODISCARD Vector2f	getChildWidgetsOffset () const
	Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0)

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 String &rootDirectory="") const
	Saves the child widgets to a text file.

void	loadWidgetsFromNodeTree (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting=true)
	Loads the child widgets from a tree of nodes that contain all information about the widgets.

TGUI_NODISCARD std::unique_ptr< DataIO::Node >	saveWidgetsToNodeTree (const String &rootDirectory="") const
	Saves the child widgets to a tree of nodes that contain all information about 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.

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

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

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

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

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

virtual TGUI_NODISCARD Widget::Ptr	getWidgetAtPos (Vector2f pos, bool recursive) const
	Returns the widget that is located at the given position.

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

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

void	setFocused (bool focused) override
	Focus or unfocus the widget.

bool	processMouseMoveEvent (Vector2f pos)
	Inform the container about a mouse move event.

bool	processMousePressEvent (Event::MouseButton button, Vector2f pos)
	Inform the container about a mouse press event.

bool	processMouseReleaseEvent (Event::MouseButton button, Vector2f pos)
	Inform the container about a mouse release event.

bool	processScrollEvent (float delta, Vector2f pos, bool touch)
	Inform the container about a scroll event (either mouse wheel or two finger scrolling on touchscreen)

bool	processKeyPressEvent (Event::KeyEvent event)
	Inform the container about a key press event.

bool	processTextEnteredEvent (char32_t key)
	Inform the container about a key press event.

void	childWidgetFocused (const Widget::Ptr &child)

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

void	rightMousePressed (Vector2f pos) override

void	leftMouseReleased (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

void	keyPressed (const Event::KeyEvent &event) override

bool	canHandleKeyPress (const Event::KeyEvent &event) override
	Called by the parent of the widget to check if keyPressed would process the event.

void	textEntered (char32_t key) override

bool	scrolled (float delta, Vector2f pos, bool touch) override
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

void	mouseNoLongerOnWidget () override

void	leftMouseButtonNoLongerDown () override

void	rightMouseButtonNoLongerDown () override

TGUI_NODISCARD Widget::Ptr	askToolTip (Vector2f mousePos) override

bool	updateTime (Duration elapsedTime) override

void	setParent (Container *parent) override

void	setParentGui (BackendGui *gui)

void	updateChildrenWithAutoLayout ()

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&) noexcept
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&) noexcept
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

virtual TGUI_NODISCARD WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

virtual TGUI_NODISCARD const WidgetRenderer *	getSharedRenderer () const

virtual TGUI_NODISCARD WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

TGUI_NODISCARD Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

TGUI_NODISCARD Vector2f	getSize () const
	Returns the size of the widget.

virtual TGUI_NODISCARD Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual TGUI_NODISCARD Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

virtual TGUI_NODISCARD Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

TGUI_NODISCARD AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

TGUI_NODISCARD Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

TGUI_NODISCARD Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

TGUI_NODISCARD Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

TGUI_NODISCARD float	getRotation () const
	Returns the rotation to be applied to the widget.

TGUI_NODISCARD Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration.

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

TGUI_NODISCARD bool	isVisible () const
	Returns true when the widget is visible.

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

TGUI_NODISCARD bool	isEnabled () const
	Returns true when the widget is enabled.

TGUI_NODISCARD bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

TGUI_NODISCARD const String &	getWidgetType () const
	Returns the type of the widget.

TGUI_NODISCARD Container *	getParent () const
	Returns a pointer to the parent widget.

TGUI_NODISCARD BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

TGUI_NODISCARD bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

void	moveToFront ()
	Places the widget before all other widgets.

void	moveToBack ()
	Places the widget behind all other widgets.

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename DataType >
TGUI_NODISCARD DataType	getUserData () const
	Returns data stored in the widget.

TGUI_NODISCARD bool	hasUserData () const
	Returns whether data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

TGUI_NODISCARD const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

TGUI_NODISCARD float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

TGUI_NODISCARD unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

TGUI_NODISCARD Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

void	setWidgetName (const String &name)
	Changes the name of a widget.

TGUI_NODISCARD String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

TGUI_NODISCARD Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

TGUI_NODISCARD bool	isFocusable () const
	Returns whether a widget could be focused.

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationUp () const
	Returns which widget would become focused when navigating upwards from this widget.

void	setNavigationDown (const Widget::Ptr &widgetBelow)
	Changes which widget should become focused when navigating downwards from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationDown () const
	Returns which widget would become focused when navigating downwards from this widget.

void	setNavigationLeft (const Widget::Ptr &widgetLeft)
	Changes which widget should become focused when navigating to the left from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationLeft () const
	Returns which widget would become focused when navigating to the left from this widget.

void	setNavigationRight (const Widget::Ptr &widgetRight)
	Changes which widget should become focused when navigating to the right from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

virtual TGUI_NODISCARD bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

TGUI_NODISCARD bool	isContainer () const
	Returns whether the widget is a container widget or not.

TGUI_NODISCARD bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

TGUI_NODISCARD const Layout2d &	getPositionLayout () const

TGUI_NODISCARD const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

void	rendererChangedCallback (const String &property)

Static Public Member Functions
static TGUI_NODISCARD TabContainer::Ptr	create (const Layout2d &size={ "100%", "100%" })
	Creates a new tab container widget.

static TGUI_NODISCARD TabContainer::Ptr	copy (const TabContainer::ConstPtr &tabContainer)
	Makes a copy of another tab container.

Public Attributes
SignalInt	onSelectionChange = {"SelectionChanged"}
	Selection of the tab container changed. Optional parameter: index of panel with selection.

SignalTyped2< int, bool * >	onSelectionChanging = {"SelectionChanging"}

Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.

SignalAnimationType	onAnimationFinish = {"AnimationFinished"}
	An animation has finished.

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "TabContainer"
	Type name of the widget.

Protected Member Functions
TGUI_NODISCARD Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

TGUI_NODISCARD Widget::Ptr	clone () const override
	Makes a copy of the widget.

TGUI_NODISCARD std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree of nodes in order to save it to a file.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

Protected Member Functions inherited from tgui::Container
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the child widgets to a render target.

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

TGUI_NODISCARD Widget::Ptr	getWidgetBelowMouse (Vector2f mousePos) const

Widget::Ptr	updateWidgetBelowMouse (Vector2f mousePos)

TGUI_NODISCARD std::size_t	getFocusedWidgetIndex () const

bool	tryFocusWidget (const Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive)

TGUI_NODISCARD Vector2f	transformMousePos (const Widget::Ptr &widget, Vector2f mousePos) const

void	widgetAdded (const Widget::Ptr &widgetPtr)

void	injectFormFilePath (const std::unique_ptr< DataIO::Node > &node, const String &path, std::map< String, bool > &checkedFilenames) const

void	loadWidgetsImpl (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting)

Protected Member Functions inherited from tgui::Widget
virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Additional Inherited Members
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>

using	LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>

Protected Attributes inherited from tgui::Container
std::vector< Widget::Ptr >	m_widgets

Widget::Ptr	m_widgetBelowMouse

Widget::Ptr	m_widgetWithLeftMouseDown

Widget::Ptr	m_widgetWithRightMouseDown

Widget::Ptr	m_focusedWidget

bool	m_draggingWidget = false

Vector2f	m_prevInnerSize

bool	m_isolatedFocus = false

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position
	Stores the position of this widget.

Layout2d	m_size
	Stores the size of this widget.

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::unique_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

AutoLayout	m_autoLayout = AutoLayout::Manual

bool	m_autoLayoutUpdateEnabled = true

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Detailed Description

TabContainer widget.

A tab container widget is a control that allow user to switch between panels via tabs. If you are looking for something without holding panels then check out the Tabs class.

Warning: Do not add widgets directly to this container! Only add things to the panels returned by addTab and insertTab.

Member Enumeration Documentation

◆ TabAlign

enum tgui::TabContainer::TabAlign

Enumeration of the tab alignments for tabs.

Enumerator
Top	Tabs are above panels.
Bottom	Tabs are below panels.

Member Function Documentation

◆ addTab()

Panel::Ptr tgui::TabContainer::addTab	(	const String &	name,
		bool	select = true )

Adds a new tab and corresponding panel.

Parameters

name	Text for the tab
select	Should the tab be selected? Optional parameter, default value is true

Returns: Newly created panel that corresponds to the new tab

◆ changeTabText()

bool tgui::TabContainer::changeTabText	(	std::size_t	index,
		const String &	text )

Changes the text of one of the tabs.

Parameters

index	The index of the tab to be changed. The first tab has index 0
text	The new text of the tab that will be drawn on top of it

Returns: True when text was successfully changed, false when index was too high

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::TabContainer::clone ( ) const

overrideprotectedvirtual

Makes a copy of the widget.

Implements tgui::Widget.

◆ copy()

static TGUI_NODISCARD TabContainer::Ptr tgui::TabContainer::copy ( const TabContainer::ConstPtr & tabContainer )

static

Makes a copy of another tab container.

Parameters

tabContainer The other tab container

Returns: The new tab container

◆ create()

static TGUI_NODISCARD TabContainer::Ptr tgui::TabContainer::create ( const Layout2d & size = { "100%", "100%" } )

static

Creates a new tab container widget.

Returns: The new tab container

◆ getIndex()

TGUI_NODISCARD int tgui::TabContainer::getIndex ( const Panel::Ptr & panel )

Returns index of the specified panel.

Parameters

panel Panel to find

Returns: Index of the specified panel or -1 if not found

◆ getPanel()

TGUI_NODISCARD Panel::Ptr tgui::TabContainer::getPanel ( int index )

Returns the panel with given index.

Parameters

index Index of panel to get

Returns: Panel with given index

◆ getPanelCount()

TGUI_NODISCARD std::size_t tgui::TabContainer::getPanelCount ( ) const

Returns the number of holded panels.

Returns: Number of panels in the tab container

◆ getSelected()

TGUI_NODISCARD Panel::Ptr tgui::TabContainer::getSelected ( )

Returns the selected panel or nullptr.

Returns: Selected panel or nullptr

◆ getSelectedIndex()

TGUI_NODISCARD int tgui::TabContainer::getSelectedIndex ( ) const

Returns index of the selected panel.

Returns: Index of the selected panel or -1 for empty tab container

◆ getSignal()

TGUI_NODISCARD Signal & tgui::TabContainer::getSignal ( String signalName )

overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::Widget.

◆ getTabAlignment()

TGUI_NODISCARD TabContainer::TabAlign tgui::TabContainer::getTabAlignment ( ) const

Returns the alignment of the tabs.

Returns: The current tab alignment

◆ getTabFixedSize()

TGUI_NODISCARD float tgui::TabContainer::getTabFixedSize ( ) const

Returns the tab fixed size for fixed size alignment, default is 0.0f.

Returns: The current tab fixed size

◆ getTabs()

TGUI_NODISCARD Tabs::Ptr tgui::TabContainer::getTabs ( )

Returns internal tabs widget.

Returns: Internal tabs widget

◆ getTabsRenderer()

TGUI_NODISCARD TabsRenderer * tgui::TabContainer::getTabsRenderer ( )

Returns the renderer of tabs part of widget.

Returns: Temporary pointer to the renderer

Warning: After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getTabsSharedRenderer()

TGUI_NODISCARD TabsRenderer * tgui::TabContainer::getTabsSharedRenderer ( )

Returns the renderer of tabs part of widget.

Returns: Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getTabText()

TGUI_NODISCARD String tgui::TabContainer::getTabText ( std::size_t index ) const

Gets the text of one of the tabs.

Parameters

index The index of the tab. The first tab has index 0

Returns: The text on the tab or an empty string when index was too high

◆ insertTab()

Panel::Ptr tgui::TabContainer::insertTab	(	std::size_t	index,
		const String &	name,
		bool	select = true )

Inserts a new tab and panel somewhere between the existing ones.

Parameters

index	The index where the tab gets inserted. 0 means before the first tab, 1 means behind the first tab
name	Text for the tab
select	Should the tab be selected? Optional parameter, default value is true

Returns: Newly created panel that corresponds to the new tab

◆ isMouseOnWidget()

TGUI_NODISCARD bool tgui::TabContainer::isMouseOnWidget ( Vector2f pos ) const

overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns: Is the mouse on top of the widget?

Implements tgui::Widget.

◆ load()

void tgui::TabContainer::load	(	const std::unique_ptr< DataIO::Node > &	node,
		const LoadingRenderersMap &	renderers )

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Container.

◆ removeTab() [1/2]

bool tgui::TabContainer::removeTab ( const String & text )

Removes a tab and its corresponding panel, given the text of the tab.

Parameters

text	The text on the tab to remove

Returns: Whether a tab was removed, false is returned when the text didn't match any tab

See also: removeTab(std::size_t)

◆ removeTab() [2/2]

bool tgui::TabContainer::removeTab ( std::size_t index )

Removes a tab and its corresponding panel with a given index.

Parameters

index The index of the tab to remove

Returns: Whether a tab was removed, false is returned when the index was too high

See also: removeTab(String)

◆ save()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::TabContainer::save ( SavingRenderersMap & renderers ) const

overrideprotectedvirtual

Saves the widget as a tree of nodes in order to save it to a file.

Reimplemented from tgui::Container.

◆ select()

void tgui::TabContainer::select ( std::size_t index )

Sets selection to panel.

Parameters

index Index of panel to select

◆ setSize() [1/4]

virtual void tgui::Widget::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Container.

◆ setSize() [2/4]

void tgui::TabContainer::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the tab container.

Parameters

size	The new size of the tab container

Reimplemented from tgui::Container.

◆ setSize() [3/4]

void tgui::Container::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the container.

Parameters

size	The new size of the container

Reimplemented from tgui::Container.

◆ setSize() [4/4]

void tgui::Widget::setSize	(	Layout	width,
		Layout	height )

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setTabAlignment()

void tgui::TabContainer::setTabAlignment ( TabContainer::TabAlign align )

Changes the alignment of the tabs.

The possible alignments can be found in the tgui::TabContainer::TabAlign enum. The default alignment is tgui::TabContainer::TabAlign::Top.

Parameters

align New tab alignment

◆ setTabFixedSize()

void tgui::TabContainer::setTabFixedSize ( float fixedSize )

Changes the tab fixed size for fixed size alignment.

The tab fixed size is applied equally to all tabs of the TabContainer. A value less than or equal to 0.0f sets the width of the tabs to the automatic width (tabs fill the TabContainer). A value greater than zero sets the width of the tabs to the specified value.

Parameters

fixedSize New tab fixed size

◆ setTabsHeight()

void tgui::TabContainer::setTabsHeight ( const Layout & height )

Changes the height of tabs part of the widget.

Parameters

height Height of tabs part of the widget

Member Data Documentation

◆ onSelectionChanging

SignalTyped2<int, bool*> tgui::TabContainer::onSelectionChanging = {"SelectionChanging"}

Selection of the tab container changing. Selection changing can be vetoed if to set second parameter to false in handler.

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

include/TGUI/Widgets/TabContainer.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TabAlign

Member Function Documentation

◆ addTab()

◆ changeTabText()

◆ clone()

◆ copy()

◆ create()

◆ getIndex()

◆ getPanel()

◆ getPanelCount()

◆ getSelected()

◆ getSelectedIndex()

◆ getSignal()

◆ getTabAlignment()

◆ getTabFixedSize()

◆ getTabs()

◆ getTabsRenderer()

◆ getTabsSharedRenderer()

◆ getTabText()

◆ insertTab()

◆ isMouseOnWidget()

◆ load()

◆ removeTab() [1/2]

◆ removeTab() [2/2]

◆ save()

◆ select()

◆ setSize() [1/4]

◆ setSize() [2/4]

◆ setSize() [3/4]

◆ setSize() [4/4]

◆ setTabAlignment()

◆ setTabFixedSize()

◆ setTabsHeight()

Member Data Documentation

◆ onSelectionChanging