TGUI  0.8-dev

Tabs widget. More...

#include <Tabs.hpp>

Inheritance diagram for tgui::Tabs:
tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

typedef std::shared_ptr< TabsPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const TabsConstPtr
 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

TabsRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setSize (const Layout2d &size) override
 This function currently does nothing. More...
 
virtual sf::Vector2f getSize () const override
 Returns the size of the tabs. More...
 
std::size_t add (const sf::String &text, bool select=true)
 Adds a new tab. More...
 
void insert (std::size_t index, const sf::String &text, bool select=true)
 Inserts a new tab somewhere between the other tabs. More...
 
sf::String getText (std::size_t index) const
 Gets the text of one of the tabs. More...
 
bool changeText (std::size_t index, const sf::String &text)
 Changes the text of one of the tabs. More...
 
void select (const sf::String &text)
 Selects the tab with a given text. More...
 
void select (std::size_t index)
 Selects the tab with a given index. More...
 
void deselect ()
 Deselects the selected tab.
 
void remove (const sf::String &text)
 Removes a tab with a given text. More...
 
void remove (std::size_t index)
 Removes a tab with a given index. More...
 
void removeAll ()
 Removes all tabs.
 
sf::String getSelected () const
 Gets the text that is drawn on the currently selected tab. More...
 
int getSelectedIndex () const
 Gets the index of the currently selected tab. More...
 
void setTextSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns the character size of the text. More...
 
void setTabHeight (float height)
 Changes the height of the tabs. More...
 
float getTabHeight () const
 Returns the height of the tabs. More...
 
void setMaximumTabWidth (float maximumWidth)
 Changes the maximum tab width of the tabs. More...
 
float getMaximumTabWidth () const
 Returns the maximum tab width of the tabs. More...
 
std::size_t getTabsCount () const
 Returns the amount of tabs. More...
 
virtual void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~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...
 
WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 sets the position of the widget More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable ()
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void move (const Layout2d &offset)
 Moves the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Moves the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
void scale (const Layout2d &factors)
 Scales the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scales the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
virtual ~SignalWidgetBase ()
 Virtual destructor.
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnects all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnects all connections from a all signals.
 

Static Public Member Functions

static Tabs::Ptr create ()
 Creates a new tabs widget. More...
 
static Tabs::Ptr copy (Tabs::ConstPtr tab)
 Makes a copy of another tab. More...
 

Protected Member Functions

virtual void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
virtual Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- 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.
 

Detailed Description

Tabs widget.

Signals:

  • TabSelected (Another tab has been selected)
    • Optional parameter sf::String: New text on the newly selected tab
    • Uses Callback member 'text'
  • Inherited signals from Widget

Member Function Documentation

§ add()

std::size_t tgui::Tabs::add ( const sf::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 sf::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()

virtual Widget::Ptr tgui::Tabs::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 Tabs::Ptr tgui::Tabs::copy ( Tabs::ConstPtr  tab)
static

Makes a copy of another tab.

Parameters
tabThe other tab
Returns
The new tab

§ create()

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

Creates a new tabs widget.

Returns
The new tabs

§ draw()

virtual void tgui::Tabs::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

§ getMaximumTabWidth()

float tgui::Tabs::getMaximumTabWidth ( ) const

Returns the maximum tab width of the tabs.

Returns
Maximum tab width

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.

§ getRenderer()

TabsRenderer* tgui::Tabs::getRenderer ( ) const
inline

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

Returns
Temporary pointer to the renderer

§ getSelected()

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

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

§ getSize()

virtual sf::Vector2f tgui::Tabs::getSize ( ) const
inlineoverridevirtual

Returns the size of the tabs.

Returns
Size of the tabs

Reimplemented from tgui::Transformable.

§ getTabHeight()

float tgui::Tabs::getTabHeight ( ) const

Returns the height of the tabs.

Returns
Tab height

§ getTabsCount()

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

Returns the amount of tabs.

Returns
Number of tabs

§ getText()

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

§ getTextSize()

unsigned int tgui::Tabs::getTextSize ( ) const

Returns the character size of the text.

Returns
The text size

§ insert()

void tgui::Tabs::insert ( std::size_t  index,
const sf::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?

§ remove() [1/2]

void tgui::Tabs::remove ( const sf::String &  text)

Removes a tab with a given text.

Parameters
textThe text on the tab to remove

When multiple tabs have the same text, only the first will be removed.

See also
remove(unsigned int)

§ remove() [2/2]

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

Removes a tab with a given index.

Parameters
indexThe index of the tab to remove

When the index is too high then nothing will happen.

See also
remove(sf::String)

§ rendererChanged()

virtual void tgui::Tabs::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

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

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Widget.

§ select() [1/2]

void tgui::Tabs::select ( const sf::String &  text)

Selects the tab with a given text.

Parameters
textThe text of the tab to select

When the text doen't match any tab then nothing will be changed. If there are multiple tabs with the same text then the first one will be selected.

See also
select(int)

§ select() [2/2]

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

Selects the tab with a given index.

Parameters
indexThe index of the tab to select

When the index is too high then nothing will happen.

See also
select(sf::String)

§ setMaximumTabWidth()

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

Changes the maximum tab width of the tabs.

Parameters
maximumWidthMaximum width of a single tab

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.

§ setSize()

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

This function currently does nothing.

Parameters
sizeCurrently ignored

It is not yet possible to change the size directly.

See also
setTabHeight
setDistanceToSide
setMaximumTabWidth

Reimplemented from tgui::Widget.

§ setTabHeight()

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

Changes the height of the tabs.

Parameters
heightHeight of the tabs

By default, it is the height of the tab image that is loaded with the load function.

§ setTextSize()

void tgui::Tabs::setTextSize ( unsigned int  size)

Changes the character size of the text.

Parameters
sizeThe new size of the text If the size is 0 (default) then the text will be scaled to fit in the tab.

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