TGUI  1.4.0
Loading...
Searching...
No Matches

Tabs widget. More...

#include <TGUI/Widgets/Tabs.hpp>

Inheritance diagram for tgui::Tabs:
tgui::Widget

Classes

struct  Tab
 

Public Types

using Ptr = std::shared_ptr<Tabs>
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr<const Tabs>
 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

 Tabs (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
TGUI_NODISCARD TabsRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const TabsRenderergetSharedRenderer () const override
 
TGUI_NODISCARD TabsRenderergetRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
void setSize (const Layout2d &size) override
 Changes the area used by the tabs.
 
void setEnabled (bool enabled) override
 Enables or disables the widget.
 
void setAutoSize (bool autoSize)
 Changes whether the tabs are auto-sized or not.
 
TGUI_NODISCARD bool getAutoSize () const
 Returns whether the tabs are auto-sized or not.
 
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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD String getSelected () const
 Gets the text that is drawn on the currently selected tab.
 
TGUI_NODISCARD int getSelectedIndex () const
 Gets the index of the currently selected tab.
 
void setTabVisible (std::size_t index, bool visible)
 Changes whether a tab is visible.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD bool getTabEnabled (std::size_t index) const
 Returns whether the tab is enabled or disabled.
 
void setTabHeight (float height)
 Changes the height of the tabs.
 
void setMaximumTabWidth (float maximumWidth)
 Changes the maximum tab width of the tabs.
 
TGUI_NODISCARD float getMaximumTabWidth () const
 Returns the maximum tab width of the tabs.
 
void setMinimumTabWidth (float minimumWidth)
 Changes the minimum tab width of the tabs.
 
TGUI_NODISCARD float getMinimumTabWidth () const
 Returns the minimum tab width of the tabs.
 
TGUI_NODISCARD std::size_t getTabsCount () const
 Returns the amount of tabs.
 
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.
 
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 mouseNoLongerOnWidget () 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::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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.
 
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.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () 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 FontgetInheritedFont () 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 setIgnoreMouseEvents (bool ignore)
 Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
 
TGUI_NODISCARD 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 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.
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (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 TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () 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 Tabs::Ptr create ()
 Creates a new tabs widget.
 
static TGUI_NODISCARD Tabs::Ptr copy (const Tabs::ConstPtr &tab)
 Makes a copy of another tab.
 

Public Attributes

SignalString onTabSelect = {"TabSelected"}
 A tab that was selected. 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.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "Tabs"
 Type name of the widget.
 

Protected Member Functions

TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
void recalculateTabsWidth ()
 
void updateTextColors ()
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
TGUI_NODISCARD 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.
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer)
 
TGUI_NODISCARD 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::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_maximumTabWidth = 0
 
float m_minimumTabWidth = 0
 
int m_selectedTab = -1
 
int m_hoveringTab = -1
 
bool m_autoSize = true
 
std::vector< Tabm_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
 
- 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< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_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

- 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

Tabs widget.

If you are looking for something that allow holds multiple panels, displayed one panel at a time then check out the TabContainer class.

Member Function Documentation

◆ add()

std::size_t tgui::Tabs::add ( const String & text,
bool select = true )

Adds a new tab.

Parameters
textThe text of the tab that will be drawn on top of it
selectDo you want the new tab to be selected immediately?
Returns
The index of the tab in the list
Warning
The index returned by this function may no longer be correct when a tab is removed

◆ changeText()

bool tgui::Tabs::changeText ( std::size_t index,
const String & text )

Changes the text of one of the tabs.

Parameters
indexThe index of the tab to be changed. The first tab has index 0
textThe 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::Tabs::clone ( ) const
overrideprotectedvirtual

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()

static TGUI_NODISCARD Tabs::Ptr tgui::Tabs::copy ( const Tabs::ConstPtr & tab)
static

Makes a copy of another tab.

Parameters
tabThe other tab
Returns
The new tab

◆ create()

static TGUI_NODISCARD Tabs::Ptr tgui::Tabs::create ( )
static

Creates a new tabs widget.

Returns
The new tabs

◆ draw()

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

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getAutoSize()

TGUI_NODISCARD bool tgui::Tabs::getAutoSize ( ) const

Returns whether the tabs are auto-sized or not.

Returns
Is the width of the tabs dependent on their content?

◆ getMaximumTabWidth()

TGUI_NODISCARD float tgui::Tabs::getMaximumTabWidth ( ) const

Returns the maximum tab width of the tabs.

Returns
Maximum tab width

This property only has effect when the tabs are auto-sizing.

If the text on the tab is longer than this width then it will be cropped to fit inside the tab. By default, the maximum width is 0 which means that there is no limitation.

◆ getMinimumTabWidth()

TGUI_NODISCARD float tgui::Tabs::getMinimumTabWidth ( ) const

Returns the minimum tab width of the tabs.

Returns
Minimum tab width

This property only has effect when the tabs are auto-sizing.

Every tab is at least as wide as this minimum or twice the distance to side.

◆ getRenderer()

TGUI_NODISCARD TabsRenderer * tgui::Tabs::getRenderer ( )
overridevirtual

Returns the renderer, which gives access to functions that determine how the widget is displayed.

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.

Reimplemented from tgui::Widget.

◆ getSelected()

TGUI_NODISCARD String tgui::Tabs::getSelected ( ) const

Gets the text that is drawn on the currently selected tab.

Returns
The text on the tab. When no tab is selected then this function returns an empty string

◆ getSelectedIndex()

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

Gets the index of the currently selected tab.

Returns
The index of the tab. When no tab is selected then this function returns -1
Warning
The index returned by this function may no longer be correct when a tab is removed

◆ getSharedRenderer() [1/2]

TGUI_NODISCARD const TabsRenderer * tgui::Tabs::getSharedRenderer ( ) const
overridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD TabsRenderer * tgui::Tabs::getSharedRenderer ( )
overridevirtual

Returns the renderer, which gives access to functions that determine how the widget is displayed.

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

Reimplemented from tgui::Widget.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::Tabs::getSignal ( String signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getTabEnabled()

TGUI_NODISCARD bool tgui::Tabs::getTabEnabled ( std::size_t index) const

Returns whether the tab is enabled or disabled.

Parameters
indexThe index of the tab
Returns
Whether the tab is enabled

◆ getTabsCount()

TGUI_NODISCARD std::size_t tgui::Tabs::getTabsCount ( ) const

Returns the amount of tabs.

Returns
Number of tabs

◆ getTabVisible()

TGUI_NODISCARD bool tgui::Tabs::getTabVisible ( std::size_t index) const

Returns whether the tab is shown or hidden.

Parameters
indexThe index of the tab
Returns
Whether the tab is visible

◆ getText()

TGUI_NODISCARD String tgui::Tabs::getText ( std::size_t index) const

Gets the text of one of the tabs.

Parameters
indexThe 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

◆ insert()

void tgui::Tabs::insert ( std::size_t index,
const String & text,
bool select = true )

Inserts a new tab somewhere between the other tabs.

Parameters
indexThe index where the tab gets inserted. 0 means before the first tab, 1 means behind the first tab
textThe text of the tab that will be drawn on top of it
selectDo you want the new tab to be selected immediately?

◆ isMouseOnWidget()

TGUI_NODISCARD bool tgui::Tabs::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.

◆ leftMousePressed()

bool tgui::Tabs::leftMousePressed ( Vector2f pos)
overridevirtual

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

Parameters
posMouse 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::Tabs::load ( const std::unique_ptr< DataIO::Node > & node,
const LoadingRenderersMap & renderers )
overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::Tabs::mouseMoved ( Vector2f pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::Tabs::mouseNoLongerOnWidget ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ remove() [1/2]

bool tgui::Tabs::remove ( const String & text)

Removes a tab with a given text.

Parameters
textThe 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
remove(std::size_t)

◆ remove() [2/2]

bool tgui::Tabs::remove ( std::size_t index)

Removes a tab with a given index.

Parameters
indexThe index of the tab to remove
Returns
Whether a tab was removed, false is returned when the index was too high
See also
remove(String)

◆ rendererChanged()

void tgui::Tabs::rendererChanged ( const String & property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

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

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

Reimplemented from tgui::Widget.

◆ select() [1/2]

bool tgui::Tabs::select ( const String & text)

Selects the tab with a given text.

Parameters
textThe text of the tab to select
Returns
Whether a tab was selected, false is returned if tab doesn't exist or is invisible or disabled
See also
select(int)

If there are multiple tabs with the same text then the first one will be selected. When false is returned, the selected tab will still be deselected.

◆ select() [2/2]

bool tgui::Tabs::select ( std::size_t index)

Selects the tab with a given index.

Parameters
indexThe index of the tab to select
Returns
Whether a tab was selected, false is returned if the index was too high or if tab is invisible or disabled
See also
select(String)

When false is returned, the selected tab will still be deselected.

◆ setAutoSize()

void tgui::Tabs::setAutoSize ( bool autoSize)

Changes whether the tabs are auto-sized or not.

Parameters
autoSizeShould the size of the tabs depend on their content?

When the tabs are in auto-size mode, the width of the tabs will be depend on the text which they contain. Otherwise, all tabs have an equal width to fill the size of the widget.

The tabs are auto-sized by default.

◆ setEnabled()

void tgui::Tabs::setEnabled ( bool enabled)
overridevirtual

Enables or disables the widget.

Parameters
enabledIs the widget enabled?

The disabled widget will no longer receive events and thus no longer send callbacks. All widgets are enabled by default.

Reimplemented from tgui::Widget.

◆ setMaximumTabWidth()

void tgui::Tabs::setMaximumTabWidth ( float maximumWidth)

Changes the maximum tab width of the tabs.

Parameters
maximumWidthMaximum width of a single tab

This property only has effect when the tabs are auto-sizing.

If the text on the tab is longer than this width then it will be cropped to fit inside the tab. By default, the maximum width is 0 which means that there is no limitation.

◆ setMinimumTabWidth()

void tgui::Tabs::setMinimumTabWidth ( float minimumWidth)

Changes the minimum tab width of the tabs.

Parameters
minimumWidthMinimum width of a single tab

This property only has effect when the tabs are auto-sizing.

Every tab is at least as wide as this minimum or twice the distance to side.

◆ setSize() [1/2]

void tgui::Tabs::setSize ( const Layout2d & size)
overridevirtual

Changes the area used by the tabs.

Parameters
sizeTotal size of the tabs

When this function is called, the tabs will no longer be auto-sizing, but each tab will get an equal width such that the total width corresponds to the size passed to this function.

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
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setTabEnabled()

void tgui::Tabs::setTabEnabled ( std::size_t index,
bool enabled )

Changes whether a tab is enabled.

Parameters
indexThe index of the tab to enable or disable
enabledIs the tab enabled?

◆ setTabHeight()

void tgui::Tabs::setTabHeight ( float height)

Changes the height of the tabs.

Parameters
heightHeight of the tabs

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

◆ setTabVisible()

void tgui::Tabs::setTabVisible ( std::size_t index,
bool visible )

Changes whether a tab is visible.

Parameters
indexThe index of the tab to show or hide
visibleIs the tab shown?

◆ updateTextSize()

void tgui::Tabs::updateTextSize ( )
overrideprotectedvirtual

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

Reimplemented from tgui::Widget.


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