TGUI
0.9.5
|
#include <TGUI/Widgets/Tabs.hpp>
Classes | |
struct | Tab |
Public Types | |
typedef std::shared_ptr< Tabs > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Tabs > | ConstPtr |
Shared constant widget pointer. | |
Public Types inherited from tgui::Widget | |
typedef std::shared_ptr< Widget > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Widget > | ConstPtr |
Shared constant widget pointer. | |
Public Member Functions | |
Tabs (const char *typeName="Tabs", bool initRenderer=true) | |
TabsRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const TabsRenderer * | getSharedRenderer () const |
TabsRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const TabsRenderer * | getRenderer () const |
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. | |
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. | |
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. | |
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. | |
void | setTextSize (unsigned int size) override |
Changes the character size of the text. | |
void | setTabHeight (float height) |
Changes the height of the tabs. | |
void | setMaximumTabWidth (float maximumWidth) |
Changes the maximum tab width of the tabs. | |
float | getMaximumTabWidth () const |
Returns the maximum tab width of the tabs. | |
void | setMinimumTabWidth (float minimumWidth) |
Changes the minimum tab width of the tabs. | |
float | getMinimumTabWidth () const |
Returns the minimum tab width of the tabs. | |
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 | leftMousePressed (Vector2f pos) override |
void | mouseMoved (Vector2f pos) override |
void | mouseNoLongerOnWidget () override |
void | draw (BackendRenderTargetBase &target, RenderStates states) const override |
Draw the widget to a render target. | |
virtual void | setSize (const Layout2d &size) |
Changes the size of the widget. | |
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 &&) | |
Move constructor. | |
virtual | ~Widget () |
Destructor. | |
Widget & | operator= (const Widget &) |
Overload of copy assignment operator. | |
Widget & | operator= (Widget &&) |
Move assignment. | |
void | setRenderer (std::shared_ptr< RendererData > rendererData) |
Sets a new renderer for the widget. The renderer determines how the widget looks. | |
WidgetRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const WidgetRenderer * | getSharedRenderer () const |
WidgetRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const WidgetRenderer * | getRenderer () const |
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 () const |
Get the absolute position of the top-left point 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 | 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. | |
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. | |
GuiBase * | 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 T > | |
T | getUserData () const |
Returns 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. | |
virtual 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. | |
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 | isDraggableWidget () const |
Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) | |
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) |
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 | keyPressed (const Event::KeyEvent &event) |
virtual void | textEntered (char32_t key) |
virtual bool | mouseWheelScrolled (float delta, Vector2f pos) |
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. | |
Static Public Member Functions | |
static Tabs::Ptr | create () |
Creates a new tabs widget. | |
static Tabs::Ptr | copy (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 | onAnimationFinish = {"AnimationFinished"} |
SignalShowEffect | onShowEffectFinish = {"ShowEffectFinished"} |
A show or hide animation finished. Optional parameters: animation type, new widget visibility or both. | |
Protected Member Functions | |
Signal & | getSignal (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. | |
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::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. | |
Protected Attributes | |
unsigned int | m_requestedTextSize = 0 |
float | m_maximumTabWidth = 0 |
float | m_minimumTabWidth = 0 |
int | m_selectedTab = -1 |
int | m_hoveringTab = -1 |
bool | m_autoSize = true |
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 |
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< 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 |
bool | m_visible = true |
Container * | m_parent = nullptr |
GuiBase * | m_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< WidgetRenderer > | m_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 |
Any | m_userData |
Cursor::Type | m_mouseCursor = Cursor::Type::Arrow |
std::function< void(const String &property)> | m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); } |
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 > > |
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.
std::size_t tgui::Tabs::add | ( | const String & | text, |
bool | select = true |
||
) |
Adds a new tab.
text | The text of the tab that will be drawn on top of it |
select | Do you want the new tab to be selected immediately? |
bool tgui::Tabs::changeText | ( | std::size_t | index, |
const String & | text | ||
) |
Changes the text of one of the tabs.
index | The index of the tab to be changed. The first tab has index 0 |
text | The new text of the tab that will be drawn on top of it |
|
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.
Implements tgui::Widget.
|
static |
Makes a copy of another tab.
tab | The other tab |
|
static |
Creates a new tabs widget.
|
overridevirtual |
Draw the widget to a render target.
target | Render target to draw to |
states | Current render states |
Implements tgui::Widget.
bool tgui::Tabs::getAutoSize | ( | ) | const |
Returns whether the tabs are auto-sized or not.
float tgui::Tabs::getMaximumTabWidth | ( | ) | const |
Returns the maximum tab width of the tabs.
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.
float tgui::Tabs::getMinimumTabWidth | ( | ) | const |
Returns the minimum tab width of the tabs.
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.
TabsRenderer * tgui::Tabs::getRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
String tgui::Tabs::getSelected | ( | ) | const |
Gets the text that is drawn on the currently selected tab.
int tgui::Tabs::getSelectedIndex | ( | ) | const |
Gets the index of the currently selected tab.
TabsRenderer * tgui::Tabs::getSharedRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Retrieves a signal based on its name.
signalName | Name of the signal |
Exception | when the name does not match any signal |
Reimplemented from tgui::Widget.
bool tgui::Tabs::getTabEnabled | ( | std::size_t | index | ) | const |
Returns whether the tab is enabled or disabled.
index | The index of the tab |
std::size_t tgui::Tabs::getTabsCount | ( | ) | const |
Returns the amount of tabs.
bool tgui::Tabs::getTabVisible | ( | std::size_t | index | ) | const |
Returns whether the tab is shown or hidden.
index | The index of the tab |
String tgui::Tabs::getText | ( | std::size_t | index | ) | const |
Gets the text of one of the tabs.
index | The index of the tab. The first tab has index 0 |
void tgui::Tabs::insert | ( | std::size_t | index, |
const String & | text, | ||
bool | select = true |
||
) |
Inserts a new tab somewhere between the other tabs.
index | The index where the tab gets inserted. 0 means before the first tab, 1 means behind the first tab |
text | The text of the tab that will be drawn on top of it |
select | Do you want the new tab to be selected immediately? |
|
overridevirtual |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
Implements tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
bool tgui::Tabs::remove | ( | const String & | text | ) |
Removes a tab with a given text.
text | The text on the tab to remove |
bool tgui::Tabs::remove | ( | std::size_t | index | ) |
Removes a tab with a given index.
index | The index of the tab to remove |
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Name of the property that was changed |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
bool tgui::Tabs::select | ( | const String & | text | ) |
Selects the tab with a given text.
text | The text of the tab to select |
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.
bool tgui::Tabs::select | ( | std::size_t | index | ) |
Selects the tab with a given index.
index | The index of the tab to select |
When false is returned, the selected tab will still be deselected.
void tgui::Tabs::setAutoSize | ( | bool | autoSize | ) |
Changes whether the tabs are auto-sized or not.
autoSize | Should 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.
|
overridevirtual |
Enables or disables the widget.
enabled | Is 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.
void tgui::Tabs::setMaximumTabWidth | ( | float | maximumWidth | ) |
Changes the maximum tab width of the tabs.
maximumWidth | Maximum 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.
void tgui::Tabs::setMinimumTabWidth | ( | float | minimumWidth | ) |
Changes the minimum tab width of the tabs.
minimumWidth | Minimum 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.
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the area used by the tabs.
size | Total 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.
Reimplemented from tgui::Widget.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
void tgui::Tabs::setTabEnabled | ( | std::size_t | index, |
bool | enabled | ||
) |
Changes whether a tab is enabled.
index | The index of the tab to enable or disable |
enabled | Is the tab enabled? |
void tgui::Tabs::setTabHeight | ( | float | height | ) |
Changes the height of the tabs.
height | Height 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.
void tgui::Tabs::setTabVisible | ( | std::size_t | index, |
bool | visible | ||
) |
Changes whether a tab is visible.
index | The index of the tab to show or hide |
visible | Is the tab shown? |
|
overridevirtual |
Changes the character size of the text.
size | The new size of the text If the size is 0 then the text will be scaled to fit in the tab. |
Reimplemented from tgui::Widget.