TGUI  1.0-alpha
Tabs.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_TAB_HPP
27#define TGUI_TAB_HPP
28
29
30#include <TGUI/Widget.hpp>
31#include <TGUI/Renderers/TabsRenderer.hpp>
32#include <TGUI/Text.hpp>
33
35
36namespace tgui
37{
44 class TGUI_API Tabs : public Widget
45 {
46 public:
47
48 typedef std::shared_ptr<Tabs> Ptr;
49 typedef std::shared_ptr<const Tabs> ConstPtr;
50
51
59 Tabs(const char* typeName = "Tabs", bool initRenderer = true);
60
61
68 static Tabs::Ptr create();
69
70
80
81
87 const TabsRenderer* getSharedRenderer() const;
88
95
96
108 void setSize(const Layout2d& size) override;
109 using Widget::setSize;
110
111
119 void setEnabled(bool enabled) override;
120
121
133 void setAutoSize(bool autoSize);
134
135
142 bool getAutoSize() const;
143
144
156 std::size_t add(const String& text, bool select = true);
157
158
167 void insert(std::size_t index, const String& text, bool select = true);
168
169
178 String getText(std::size_t index) const;
179
180
190 bool changeText(std::size_t index, const String& text);
191
192
202 bool select(const String& text);
203
204
213 bool select(std::size_t index);
214
215
220 void deselect();
221
222
229 bool remove(const String& text);
230
231
239 bool remove(std::size_t index);
240
241
246 void removeAll();
247
248
257
258
268 int getSelectedIndex() const;
269
270
276 void setTabVisible(std::size_t index, bool visible);
277
278
284 bool getTabVisible(std::size_t index) const;
285
286
292 void setTabEnabled(std::size_t index, bool enabled);
293
294
300 bool getTabEnabled(std::size_t index) const;
301
302
311 void setTabHeight(float height);
312
313
325 void setMaximumTabWidth(float maximumWidth);
326
327
339 float getMaximumTabWidth() const;
340
341
352 void setMinimumTabWidth(float minimumWidth);
353
354
365 float getMinimumTabWidth() const;
366
367
374 std::size_t getTabsCount() const;
375
376
383 bool isMouseOnWidget(Vector2f pos) const override;
384
388 void leftMousePressed(Vector2f pos) override;
389
393 void mouseMoved(Vector2f pos) override;
394
398 void mouseNoLongerOnWidget() override;
399
400
408 void draw(BackendRenderTarget& target, RenderStates states) const override;
409
410
412 protected:
413
423 Signal& getSignal(String signalName) override;
424
425
427 // Recalculates the size of each tab image.
429 void recalculateTabsWidth();
430
431
433 // Update the colors of the text that is drawn on the tabs
435 void updateTextColors();
436
437
444 void rendererChanged(const String& property) override;
445
446
450 std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
451
452
456 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
457
458
462 void updateTextSize() override;
463
464
466 // Makes a copy of the widget
468 Widget::Ptr clone() const override;
469
470
472 public:
473
474 SignalString onTabSelect = {"TabSelected"};
475
476
478 protected:
479
480 float m_maximumTabWidth = 0;
481 float m_minimumTabWidth = 0;
482 int m_selectedTab = -1;
483 int m_hoveringTab = -1;
484 bool m_autoSize = true;
485
486 struct Tab
487 {
488 bool visible;
489 bool enabled;
490 float width;
491 Text text;
492 };
493 std::vector<Tab> m_tabs;
494
495 Sprite m_spriteTab;
496 Sprite m_spriteTabHover;
497 Sprite m_spriteSelectedTab;
498 Sprite m_spriteSelectedTabHover;
499 Sprite m_spriteDisabledTab;
500
501 // Cached renderer properties
502 Borders m_bordersCached;
503 Color m_borderColorCached;
504 Color m_borderColorHoverCached;
505 Color m_selectedBorderColorCached;
506 Color m_selectedBorderColorHoverCached;
507 Color m_backgroundColorCached;
508 Color m_backgroundColorHoverCached;
509 Color m_backgroundColorDisabledCached;
510 Color m_selectedBackgroundColorCached;
511 Color m_selectedBackgroundColorHoverCached;
512 Color m_textColorCached;
513 Color m_textColorHoverCached;
514 Color m_textColorDisabledCached;
515 Color m_selectedTextColorCached;
516 Color m_selectedTextColorHoverCached;
517 float m_distanceToSideCached = 0;
518
520 };
521
523}
524
525
527
528#endif // TGUI_TAB_HPP
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Wrapper for colors.
Definition: Color.hpp:63
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Definition: Outline.hpp:39
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Definition: Sprite.hpp:45
Wrapper class to store strings.
Definition: String.hpp:79
Definition: TabsRenderer.hpp:37
Tabs widget.
Definition: Tabs.hpp:45
TabsRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void setAutoSize(bool autoSize)
Changes whether the tabs are auto-sized or not.
static Tabs::Ptr create()
Creates a new tabs widget.
std::size_t add(const String &text, bool select=true)
Adds a new tab.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
void insert(std::size_t index, const String &text, bool select=true)
Inserts a new tab somewhere between the other tabs.
bool select(std::size_t index)
Selects the tab with a given index.
bool getTabEnabled(std::size_t index) const
Returns whether the tab is enabled or disabled.
void setTabEnabled(std::size_t index, bool enabled)
Changes whether a tab is enabled.
void setEnabled(bool enabled) override
Enables or disables the widget.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
String getSelected() const
Gets the text that is drawn on the currently selected tab.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
std::shared_ptr< const Tabs > ConstPtr
Shared constant widget pointer.
Definition: Tabs.hpp:49
bool select(const String &text)
Selects the tab with a given text.
bool changeText(std::size_t index, const String &text)
Changes the text of one of the tabs.
static Tabs::Ptr copy(Tabs::ConstPtr tab)
Makes a copy of another tab.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
TabsRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
float getMinimumTabWidth() const
Returns the minimum tab width of the tabs.
void setMaximumTabWidth(float maximumWidth)
Changes the maximum tab width of the tabs.
bool remove(std::size_t index)
Removes a tab with a given index.
void deselect()
Deselects the selected tab.
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
void setTabHeight(float height)
Changes the height of the tabs.
void setMinimumTabWidth(float minimumWidth)
Changes the minimum tab width of the tabs.
void setSize(const Layout2d &size) override
Changes the area used by the tabs.
int getSelectedIndex() const
Gets the index of the currently selected tab.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
bool getAutoSize() const
Returns whether the tabs are auto-sized or not.
std::size_t getTabsCount() const
Returns the amount of tabs.
bool remove(const String &text)
Removes a tab with a given text.
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 removeAll()
Removes all tabs.
void setTabVisible(std::size_t index, bool visible)
Changes whether a tab is visible.
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
std::shared_ptr< Tabs > Ptr
Shared widget pointer.
Definition: Tabs.hpp:48
String getText(std::size_t index) const
Gets the text of one of the tabs.
bool getTabVisible(std::size_t index) const
Returns whether the tab is shown or hidden.
float getMaximumTabWidth() const
Returns the maximum tab width of the tabs.
Definition: Text.hpp:48
The parent class for every widget.
Definition: Widget.hpp:70
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
States used for drawing.
Definition: RenderStates.hpp:39
Definition: Tabs.hpp:487