tgui::VerticalTabs Class Reference

VerticalTabs widget. More...

#include <TGUI/Widgets/VerticalTabs.hpp>

Inheritance diagram for tgui::VerticalTabs:

Public Types
using	Ptr = std::shared_ptr<VerticalTabs>
	Shared widget pointer.
using	ConstPtr = std::shared_ptr<const VerticalTabs>
	Shared constant widget pointer.
Public Types inherited from tgui::TabsBase
using	Ptr = std::shared_ptr<TabsBase>
	Shared widget pointer.
using	ConstPtr = std::shared_ptr<const TabsBase>
	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
	VerticalTabs (const char *typeName=StaticWidgetType, bool initRenderer=true)
void	setSize (const Layout2d &size) override
	Changes the area used by the tabs.
void	setTabWidth (float width)
	Changes the width of the tabs.
void	setTabHeight (float height)
	Changes the height of the tabs.
float	getTabHeight () const
	Returns the height of the tabs.
bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.
void	mouseMoved (Vector2f pos) override
void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.
void	setSize (Layout width, Layout height)
	Changes the size of the widget.
Public Member Functions inherited from tgui::TabsBase
	TabsBase (const char *typeName, bool initRenderer)
TabsRenderer *	getSharedRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const TabsRenderer *	getSharedRenderer () const override
TabsRenderer *	getRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
void	setEnabled (bool enabled) override
	Enables or disables the widget.
std::size_t	add (const String &text, bool select=true)
	Adds a new tab.
void	insert (std::size_t index, const String &text, bool select=true)
	Inserts a new tab somewhere between the other tabs.
String	getText (std::size_t index) const
	Gets the text of one of the tabs.
bool	changeText (std::size_t index, const String &text)
	Changes the text of one of the tabs.
bool	select (const String &text)
	Selects the tab with a given text.
bool	select (std::size_t index)
	Selects the tab with a given index.
void	deselect ()
	Deselects the selected tab.
bool	remove (const String &text)
	Removes a tab with a given text.
bool	remove (std::size_t index)
	Removes a tab with a given index.
void	removeAll ()
	Removes all tabs.
String	getSelected () const
	Gets the text that is drawn on the currently selected tab.
int	getSelectedIndex () const
	Gets the index of the currently selected tab.
int	getHoveredIndex () const
	Gets the index of the tab below the mouse cursor.
void	setTabVisible (std::size_t index, bool visible)
	Changes whether a tab is visible.
bool	getTabVisible (std::size_t index) const
	Returns whether the tab is shown or hidden.
void	setTabEnabled (std::size_t index, bool enabled)
	Changes whether a tab is enabled.
bool	getTabEnabled (std::size_t index) const
	Returns whether the tab is enabled or disabled.
std::size_t	getTabsCount () const
	Returns the amount of tabs.
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	rightMousePressed (Vector2f pos) override
void	mouseNoLongerOnWidget () override
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 void	setPosition (const Layout2d &position)
	sets the position of the widget
void	setPosition (Layout x, Layout y)
	Sets the position of the widget.
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.
Vector2f	getSize () const
	Returns the size of the widget.
virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.
virtual Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.
virtual 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.
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.
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.
Vector2f	getScale () const
	Returns the scaling to be applied to the widget.
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.
float	getRotation () const
	Returns the rotation to be applied to the widget.
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.
bool	isVisible () const
	Returns true when the widget is visible.
bool	isEnabled () const
	Returns true when the widget is enabled.
virtual void	setFocused (bool focused)
	Focus or unfocus the widget.
bool	isFocused () const
	Returns true when the widget is focused and false otherwise.
const String &	getWidgetType () const
	Returns the type of the widget.
Container *	getParent () const
	Returns a pointer to the parent widget.
BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.
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>
DataType	getUserData () const
	Returns data stored in the widget.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.
void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.
virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.
bool	isContainer () const
	Returns whether the widget is a container widget or not.
bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.
virtual void	setParent (Container *parent)
virtual bool	updateTime (Duration elapsedTime)
void	setAutoLayoutUpdateEnabled (bool enabled)
virtual void	leftMouseReleased (Vector2f pos)
virtual void	rightMouseReleased (Vector2f pos)
virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)
virtual void	keyPressed (const Event::KeyEvent &event)
virtual bool	canHandleKeyPress (const Event::KeyEvent &event)
	Called by the parent of the widget to check if keyPressed would process the event.
virtual void	textEntered (char32_t key)
virtual bool	scrolled (float delta, Vector2f pos, bool touch)
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen).
virtual void	leftMouseButtonNoLongerDown ()
virtual void	rightMouseButtonNoLongerDown ()
virtual Widget::Ptr	askToolTip (Vector2f mousePos)
const Layout2d &	getPositionLayout () const
const Layout2d &	getSizeLayout () const
void	bindPositionLayout (Layout *layout)
void	unbindPositionLayout (Layout *layout)
void	bindSizeLayout (Layout *layout)
void	unbindSizeLayout (Layout *layout)
template<typename WidgetType>
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.
template<typename WidgetType>
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.
void	rendererChangedCallback (const String &property)

Static Public Member Functions
static VerticalTabs::Ptr	create ()
	Creates a new tabs widget.
static VerticalTabs::Ptr	copy (const VerticalTabs::ConstPtr &tab)
	Makes a copy of another tab.

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

Protected Member Functions
void	recalculateTabsSize () override
std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node 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.
Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.
Protected Member Functions inherited from tgui::TabsBase
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.
void	updateTextColors ()
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.
void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer).
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.

Protected Attributes
float	m_tabHeight = 0
Protected Attributes inherited from tgui::TabsBase
int	m_selectedTab = -1
int	m_hoveringTab = -1
std::vector< Tab >	m_tabs
Sprite	m_spriteTab
Sprite	m_spriteTabHover
Sprite	m_spriteSelectedTab
Sprite	m_spriteSelectedTabHover
Sprite	m_spriteDisabledTab
Borders	m_bordersCached
Color	m_borderColorCached
Color	m_borderColorHoverCached
Color	m_selectedBorderColorCached
Color	m_selectedBorderColorHoverCached
Color	m_backgroundColorCached
Color	m_backgroundColorHoverCached
Color	m_backgroundColorDisabledCached
Color	m_selectedBackgroundColorCached
Color	m_selectedBackgroundColorHoverCached
Color	m_textColorCached
Color	m_textColorHoverCached
Color	m_textColorDisabledCached
Color	m_selectedTextColorCached
Color	m_selectedTextColorHoverCached
float	m_distanceToSideCached = 0
float	m_roundedBorderRadiusCached = 0
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
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
bool	m_ignoreMouseEvents = false
Font	m_fontCached = Font::getGlobalFont()
float	m_opacityCached = 1
bool	m_transparentTextureCached = false
unsigned int	m_textSizeCached = 0

Additional Inherited Members
Public Attributes inherited from tgui::TabsBase
SignalString	onTabSelect = {"TabSelected"}
	A tab that was selected. Optional parameter: selected item.
SignalString	onTabRightClick = {"TabRightClicked"}
	Right mouse pressed on a tab. Optional parameter: selected item.
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.
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>>

Detailed Description

VerticalTabs widget.

For horizontal tabs (tabs displayed next to each other instead of below each other), check out the Tabs widget.

Since

TGUI 1.12

Member Function Documentation

clone()

Widget::Ptr tgui::VerticalTabs::clone ( ) const

nodiscardoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns

Copy of the widget

Implements tgui::Widget.

copy()

VerticalTabs::Ptr tgui::VerticalTabs::copy ( const VerticalTabs::ConstPtr & tab )

staticnodiscard

Makes a copy of another tab.

Parameters

tab	The other tab

Returns

The new tab

create()

VerticalTabs::Ptr tgui::VerticalTabs::create ( )

staticnodiscard

Creates a new tabs widget.

Returns

The new tabs

draw()

void tgui::VerticalTabs::draw ( BackendRenderTarget & target, RenderStates states ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

getTabHeight()

float tgui::VerticalTabs::getTabHeight ( ) const

nodiscard

Returns the height of the tabs.

Returns

Height of each tab

leftMousePressed()

bool tgui::VerticalTabs::leftMousePressed ( Vector2f pos )

overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters

pos	Mouse position in view coordinates relative to the parent widget

Returns

True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Widget.

load()

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

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::TabsBase.

mouseMoved()

void tgui::VerticalTabs::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

recalculateTabsSize()

void tgui::VerticalTabs::recalculateTabsSize ( )

overrideprotectedvirtual

Implements tgui::TabsBase.

save()

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

nodiscardoverrideprotectedvirtual

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

Reimplemented from tgui::TabsBase.

setSize() [1/2]

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

overridevirtual

Changes the area used by the tabs.

Parameters

size	Total size of the tabs

When this function is called, the tabs will no longer be auto-sizing.

See also

setAutoSize

Reimplemented from tgui::Widget.

setSize() [2/2]

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

setTabHeight()

void tgui::VerticalTabs::setTabHeight

(

float

height

)

Changes the height of the tabs.

Parameters

height

Height of the tabs

setTabWidth()

void tgui::VerticalTabs::setTabWidth

(

float

width

)

Changes the width of the tabs.

Parameters

width

Width of the tabs

When the tabs are auto-sizing, this function allows changing the width of the tabs without setting a fixed height like calling setSize would do.

---

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

• include/TGUI/Widgets/VerticalTabs.hpp