TGUI  0.9-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

TabsRenderergetTabsSharedRenderer ()
 Returns the renderer of tabs part of widget. More...
 
TabsRenderergetTabsRenderer ()
 Returns the renderer of tabs part of widget. More...
 
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...
 
void addPanel (tgui::Panel::Ptr ptr, const tgui::String &name, bool select=true)
 Adds a new panel. More...
 
bool insertPanel (tgui::Panel::Ptr ptr, const tgui::String &name, std::size_t index, bool select=true)
 Adds a new panel. More...
 
void removePanel (tgui::Panel::Ptr ptr)
 Remove panel specified by pointer. 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 (tgui::Panel::Ptr ptr)
 Returns index of the specified panel. More...
 
tgui::Panel::Ptr getSelected ()
 Returns the selected panel or nullptr. More...
 
int getSelectedIndex () const
 Returns index of the selected panel. More...
 
tgui::Panel::Ptr getPanel (int index)
 Returns the panel with given index. More...
 
tgui::Tabs::Ptr getTabs ()
 Returns internal tabs widget. More...
 
tgui::String getTabText (std::size_t index) const
 Gets the text of one of the tabs. More...
 
bool changeTabText (std::size_t index, const tgui::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
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...
 
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...
 
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 ()
 Default constructor.
 
 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...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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...
 
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 (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. 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...
 
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...
 
GuiBasegetParentGui () 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...
 
virtual void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
virtual 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...
 
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...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Static Public Member Functions

static TabContainer::Ptr create (const tgui::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.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

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.
 
- 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.
 
void draw (BackendRenderTargetBase &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 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.
 

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

◆ addPanel()

void tgui::TabContainer::addPanel ( tgui::Panel::Ptr  ptr,
const tgui::String name,
bool  select = true 
)

Adds a new panel.

Parameters
ptrPointer to panel that added
nameText for the tab
selectShould the panel be selected. Optional parameter, default value is true

◆ changeTabText()

bool tgui::TabContainer::changeTabText ( std::size_t  index,
const tgui::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
inlineoverrideprotectedvirtual

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 tgui::Layout2d size = { "100%", "100%" })
static

Creates a new tab container widget.

Returns
The new tab container

◆ getIndex()

int tgui::TabContainer::getIndex ( tgui::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()

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

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

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

tgui::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

◆ insertPanel()

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

Adds a new panel.

Parameters
ptrPointer to panel that added
nameText for the tab
indexIndex where the panel should be inserted
selectShould the panel be selected. Optional parameter, default value is true
Returns
Was the panel inserted

◆ removePanel()

void tgui::TabContainer::removePanel ( tgui::Panel::Ptr  ptr)

Remove panel specified by pointer.

Parameters
ptrPanel to remove

◆ 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

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});

◆ 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
override

Changes the size of the widget.

Parameters
sizeThe new size of the widget

◆ setSize() [4/4]

void tgui::Widget::setSize
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:
TGUI_API Layout bindHeight(GuiBase &gui)
Bind to the height of the gui view.