TGUI  0.10-beta

TabContainer widget. More...

#include <TGUI/Widgets/TabContainer.hpp>

Inheritance diagram for tgui::TabContainer:
tgui::SubwidgetContainer tgui::Widget

Public Types

typedef std::shared_ptr< TabContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const TabContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::SubwidgetContainer
typedef std::shared_ptr< SubwidgetContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const SubwidgetContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 TabContainer (const char *typeName="TabContainer", bool initRenderer=true)
 
TabsRenderergetTabsSharedRenderer ()
 Returns the renderer of tabs part of widget. More...
 
const TabsRenderergetTabsSharedRenderer () const
 
TabsRenderergetTabsRenderer ()
 Returns the renderer of tabs part of widget. More...
 
const TabsRenderergetTabsRenderer () const
 
void setSize (const Layout2d &size) override
 Changes the size of the tab container. More...
 
void setTabsHeight (Layout height)
 Changes the height of tabs part of the widget. More...
 
Panel::Ptr addTab (const String &name, bool select=true)
 Adds a new tab and corresponding panel. More...
 
Panel::Ptr insertTab (std::size_t index, const String &name, bool select=true)
 Inserts a new tab and panel somewhere between the existing ones. More...
 
bool removeTab (const String &text)
 Removes a tab and its corresponding panel, given the text of the tab. More...
 
bool removeTab (std::size_t index)
 Removes a tab and its corresponding panel with a given index. More...
 
void select (std::size_t index, bool genEvents=true)
 Sets selection to panel. More...
 
std::size_t getPanelCount () const
 Returns the number of holded panels. More...
 
int getIndex (Panel::Ptr ptr)
 Returns index of the specified panel. More...
 
Panel::Ptr getSelected ()
 Returns the selected panel or nullptr. More...
 
int getSelectedIndex () const
 Returns index of the selected panel. More...
 
Panel::Ptr getPanel (int index)
 Returns the panel with given index. More...
 
Tabs::Ptr getTabs ()
 Returns internal tabs widget. More...
 
String getTabText (std::size_t index) const
 Gets the text of one of the tabs. More...
 
bool changeTabText (std::size_t index, const String &text)
 Changes the text of one of the tabs. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::SubwidgetContainer
 SubwidgetContainer (const char *typeName, bool initRenderer)
 
void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
ContainergetContainer ()
 Returns a pointer to the internal container. More...
 
const ContainergetContainer () const
 Returns a const pointer to the internal container. More...
 
void leftMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void rightMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
void keyPressed (const Event::KeyEvent &event) override
 
void textEntered (char32_t key) override
 
bool mouseWheelScrolled (float delta, Vector2f pos) override
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void rightMouseButtonNoLongerDown () override
 
Widget::Ptr askToolTip (Vector2f mousePos) override
 
bool updateTime (Duration elapsedTime) override
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void setParent (Container *parent) override
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetRenderer () const
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration. More...
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
virtual bool isMouseOnWidget (Vector2f pos) const =0
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void leftMousePressed (Vector2f pos)
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual bool mouseWheelScrolled (float delta, Vector2f pos)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
virtual void draw (BackendRenderTarget &target, RenderStates states) const =0
 Draw the widget to a render target. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
virtual Widget::Ptr clone () const =0
 Makes a copy of the widget if you don't know its exact type. More...
 

Static Public Member Functions

static TabContainer::Ptr create (const Layout2d &size={ "100%", "100%" })
 Creates a new tab container widget. More...
 
static TabContainer::Ptr copy (TabContainer::ConstPtr tabContainer)
 Makes a copy of another tab container. More...
 

Public Attributes

SignalInt onSelectionChanged = { "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. More...
 

Protected Member Functions

Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
- Protected Member Functions inherited from tgui::SubwidgetContainer
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. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the subwidgets to a render target. More...
 
- Protected Member Functions inherited from tgui::Widget
virtual void rendererChanged (const String &property)
 Function called when one of the properties of the renderer is changed. More...
 
virtual std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const
 Saves the widget as a tree node in order to save it to a file. More...
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void updateTextSize ()
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

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::SubwidgetContainer
CopiedSharedPtr< Groupm_container
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 
Layout2d m_size
 
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
 
bool m_visible = true
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
std::function< void(const String &property)> m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }
 

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.

Member Function Documentation

◆ addTab()

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

Adds a new tab and corresponding panel.

Parameters
nameText for the tab
selectShould 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
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()

Widget::Ptr tgui::TabContainer::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 TabContainer::Ptr tgui::TabContainer::copy ( TabContainer::ConstPtr  tabContainer)
static

Makes a copy of another tab container.

Parameters
tabContainerThe other tab container
Returns
The new tab container

◆ create()

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

Creates a new tab container widget.

Returns
The new tab container

◆ getIndex()

int tgui::TabContainer::getIndex ( Panel::Ptr  ptr)

Returns index of the specified panel.

Parameters
ptrPanel to find
Returns
Index of the specified panel or -1 if not found

◆ getPanel()

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

Returns the panel with given index.

Parameters
indexIndex of panel to get
Returns
Panel with given index

◆ getPanelCount()

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

Returns the number of holded panels.

Returns
Number of panels in the tab container

◆ getSelected()

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

Returns the selected panel or nullptr.

Returns
Selected panel or nullptr

◆ getSelectedIndex()

int tgui::TabContainer::getSelectedIndex ( ) const

Returns index of the selected panel.

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

◆ getTabs()

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

Returns internal tabs widget.

Returns
Internal tabs widget

◆ getTabsRenderer()

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

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

String tgui::TabContainer::getTabText ( 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

◆ 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
indexThe index where the tab gets inserted. 0 means before the first tab, 1 means behind the first tab
nameText for the tab
selectShould the tab be selected? Optional parameter, default value is true
Returns
Newly created panel that corresponds to the new tab

◆ 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::SubwidgetContainer.

◆ removeTab() [1/2]

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

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

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

◆ select()

void tgui::TabContainer::select ( std::size_t  index,
bool  genEvents = true 
)

Sets selection to panel.

Parameters
indexIndex of panel to select
genEventsTo emit or not signals of selection change.

◆ setSize() [1/4]

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

Changes the size of the widget.

Parameters
sizeSize 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});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::SubwidgetContainer.

◆ setSize() [2/4]

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

Changes the size of the tab container.

Parameters
sizeThe new size of the tab container

Reimplemented from tgui::SubwidgetContainer.

◆ setSize() [3/4]

void tgui::SubwidgetContainer::setSize ( const Layout2d size)
overridevirtual

Changes the size of the widget.

Parameters
sizeThe new size of the widget

Reimplemented from tgui::SubwidgetContainer.

◆ setSize() [4/4]

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

◆ setTabsHeight()

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

Changes the height of tabs part of the widget.

Parameters
heightHeight 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: