TGUI  1.3.0
Loading...
Searching...
No Matches
Tabs.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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
36TGUI_MODULE_EXPORT namespace tgui
37{
44 class TGUI_API Tabs : public Widget
45 {
46 public:
47
48 using Ptr = std::shared_ptr<Tabs>;
49 using ConstPtr = std::shared_ptr<const Tabs>;
50
51 static constexpr const char StaticWidgetType[] = "Tabs";
52
53
61 Tabs(const char* typeName = StaticWidgetType, bool initRenderer = true);
62
63
70 TGUI_NODISCARD static Tabs::Ptr create();
71
72
81 TGUI_NODISCARD static Tabs::Ptr copy(const Tabs::ConstPtr& tab);
82
83
88 TGUI_NODISCARD TabsRenderer* getSharedRenderer() override;
89 TGUI_NODISCARD const TabsRenderer* getSharedRenderer() const override;
90
96 TGUI_NODISCARD TabsRenderer* getRenderer() override;
97
98
110 void setSize(const Layout2d& size) override;
111 using Widget::setSize;
112
113
121 void setEnabled(bool enabled) override;
122
123
135 void setAutoSize(bool autoSize);
136
137
144 TGUI_NODISCARD bool getAutoSize() const;
145
146
158 std::size_t add(const String& text, bool select = true);
159
160
169 void insert(std::size_t index, const String& text, bool select = true);
170
171
180 TGUI_NODISCARD String getText(std::size_t index) const;
181
182
192 bool changeText(std::size_t index, const String& text);
193
194
204 bool select(const String& text);
205
206
215 bool select(std::size_t index);
216
217
222 void deselect();
223
224
231 bool remove(const String& text);
232
233
241 bool remove(std::size_t index);
242
243
248 void removeAll();
249
250
258 TGUI_NODISCARD String getSelected() const;
259
260
270 TGUI_NODISCARD int getSelectedIndex() const;
271
272
278 void setTabVisible(std::size_t index, bool visible);
279
280
286 TGUI_NODISCARD bool getTabVisible(std::size_t index) const;
287
288
294 void setTabEnabled(std::size_t index, bool enabled);
295
296
302 TGUI_NODISCARD bool getTabEnabled(std::size_t index) const;
303
304
313 void setTabHeight(float height);
314
315
327 void setMaximumTabWidth(float maximumWidth);
328
329
341 TGUI_NODISCARD float getMaximumTabWidth() const;
342
343
354 void setMinimumTabWidth(float minimumWidth);
355
356
367 TGUI_NODISCARD float getMinimumTabWidth() const;
368
369
376 TGUI_NODISCARD std::size_t getTabsCount() const;
377
378
385 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
386
390 bool leftMousePressed(Vector2f pos) override;
391
395 void mouseMoved(Vector2f pos) override;
396
400 void mouseNoLongerOnWidget() override;
401
402
410 void draw(BackendRenderTarget& target, RenderStates states) const override;
411
412
414 protected:
415
425 TGUI_NODISCARD Signal& getSignal(String signalName) override;
426
427
429 // Recalculates the size of each tab image.
431 void recalculateTabsWidth();
432
433
435 // Update the colors of the text that is drawn on the tabs
437 void updateTextColors();
438
439
446 void rendererChanged(const String& property) override;
447
448
452 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
453
454
458 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
459
460
464 void updateTextSize() override;
465
466
468 // Makes a copy of the widget
470 TGUI_NODISCARD Widget::Ptr clone() const override;
471
472
474 public:
475
476 SignalString onTabSelect = {"TabSelected"};
477
478
480 protected:
481
482 float m_maximumTabWidth = 0;
483 float m_minimumTabWidth = 0;
484 int m_selectedTab = -1;
485 int m_hoveringTab = -1;
486 bool m_autoSize = true;
487
488 struct Tab
489 {
490 bool visible;
491 bool enabled;
492 float width;
493 Text text;
494 };
495 std::vector<Tab> m_tabs;
496
497 Sprite m_spriteTab;
498 Sprite m_spriteTabHover;
499 Sprite m_spriteSelectedTab;
500 Sprite m_spriteSelectedTabHover;
501 Sprite m_spriteDisabledTab;
502
503 // Cached renderer properties
504 Borders m_bordersCached;
505 Color m_borderColorCached;
506 Color m_borderColorHoverCached;
507 Color m_selectedBorderColorCached;
508 Color m_selectedBorderColorHoverCached;
509 Color m_backgroundColorCached;
510 Color m_backgroundColorHoverCached;
511 Color m_backgroundColorDisabledCached;
512 Color m_selectedBackgroundColorCached;
513 Color m_selectedBackgroundColorHoverCached;
514 Color m_textColorCached;
515 Color m_textColorHoverCached;
516 Color m_textColorDisabledCached;
517 Color m_selectedTextColorCached;
518 Color m_selectedTextColorHoverCached;
519 float m_distanceToSideCached = 0;
520
522 };
523
525}
526
527
529
530#endif // TGUI_TAB_HPP
Base class for render targets.
Definition BackendRenderTarget.hpp:48
Wrapper for colors.
Definition Color.hpp:74
Class to store the position or size of a widget.
Definition Layout.hpp:328
Definition Outline.hpp:39
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:62
Definition Sprite.hpp:48
Wrapper class to store strings.
Definition String.hpp:101
Definition TabsRenderer.hpp:37
Tabs widget.
Definition Tabs.hpp:45
TGUI_NODISCARD std::size_t getTabsCount() const
Returns the amount of tabs.
TGUI_NODISCARD int getSelectedIndex() const
Gets the index of the currently selected tab.
TGUI_NODISCARD float getMinimumTabWidth() const
Returns the minimum tab width of the tabs.
void setAutoSize(bool autoSize)
Changes whether the tabs are auto-sized or not.
TGUI_NODISCARD float getMaximumTabWidth() const
Returns the maximum tab width of the tabs.
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.
void setTabEnabled(std::size_t index, bool enabled)
Changes whether a tab is enabled.
TGUI_NODISCARD TabsRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
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)
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
TGUI_NODISCARD String getSelected() const
Gets the text that is drawn on the currently selected tab.
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
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.
std::shared_ptr< const Tabs > ConstPtr
Shared constant widget pointer.
Definition Tabs.hpp:49
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
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.
std::shared_ptr< Tabs > Ptr
Shared widget pointer.
Definition Tabs.hpp:48
void setTabHeight(float height)
Changes the height of the tabs.
TGUI_NODISCARD String getText(std::size_t index) const
Gets the text of one of the tabs.
void setMinimumTabWidth(float minimumWidth)
Changes the minimum tab width of the tabs.
TGUI_NODISCARD bool getTabVisible(std::size_t index) const
Returns whether the tab is shown or hidden.
void setSize(const Layout2d &size) override
Changes the area used by the tabs.
TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
static TGUI_NODISCARD Tabs::Ptr create()
Creates a new tabs widget.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
TGUI_NODISCARD 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.
TGUI_NODISCARD bool getAutoSize() const
Returns whether the tabs are auto-sized or not.
static TGUI_NODISCARD Tabs::Ptr copy(const Tabs::ConstPtr &tab)
Makes a copy of another tab.
bool remove(const String &text)
Removes a tab with a given text.
void removeAll()
Removes all tabs.
void setTabVisible(std::size_t index, bool visible)
Changes whether a tab is visible.
TGUI_NODISCARD bool getTabEnabled(std::size_t index) const
Returns whether the tab is enabled or disabled.
TGUI_NODISCARD Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
TGUI_NODISCARD TabsRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Backend-independent wrapper around the backend-specific text class.
Definition Text.hpp:50
The parent class for every widget.
Definition Widget.hpp:84
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
States used for drawing.
Definition RenderStates.hpp:39
Definition Tabs.hpp:489