Tabs.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_TAB_HPP
#define TGUI_TAB_HPP
 
#include <TGUI/Widget.hpp>
#include <TGUI/Renderers/TabsRenderer.hpp>
#include <TGUI/Text.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class TGUI_API Tabs : public Widget
 {
 public:
 
 using Ptr = std::shared_ptr<Tabs>; 
 using ConstPtr = std::shared_ptr<const Tabs>; 
 
 static constexpr const char StaticWidgetType[] = "Tabs"; 
 
 Tabs(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 TGUI_NODISCARD static Tabs::Ptr create();
 
 TGUI_NODISCARD static Tabs::Ptr copy(const Tabs::ConstPtr& tab);
 
 TGUI_NODISCARD TabsRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const TabsRenderer* getSharedRenderer() const override;
 
 TGUI_NODISCARD TabsRenderer* getRenderer() override;
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 void setEnabled(bool enabled) override;
 
 void setAutoSize(bool autoSize);
 
 TGUI_NODISCARD bool getAutoSize() const;
 
 std::size_t add(const String& text, bool select = true);
 
 void insert(std::size_t index, const String& text, bool select = true);
 
 TGUI_NODISCARD String getText(std::size_t index) const;
 
 bool changeText(std::size_t index, const String& text);
 
 bool select(const String& text);
 
 bool select(std::size_t index);
 
 void deselect();
 
 bool remove(const String& text);
 
 bool remove(std::size_t index);
 
 void removeAll();
 
 TGUI_NODISCARD String getSelected() const;
 
 TGUI_NODISCARD int getSelectedIndex() const;
 
 TGUI_NODISCARD int getHoveredIndex() const;
 
 void setTabVisible(std::size_t index, bool visible);
 
 TGUI_NODISCARD bool getTabVisible(std::size_t index) const;
 
 void setTabEnabled(std::size_t index, bool enabled);
 
 TGUI_NODISCARD bool getTabEnabled(std::size_t index) const;
 
 void setTabHeight(float height);
 
 void setMaximumTabWidth(float maximumWidth);
 
 TGUI_NODISCARD float getMaximumTabWidth() const;
 
 void setMinimumTabWidth(float minimumWidth);
 
 TGUI_NODISCARD float getMinimumTabWidth() const;
 
 TGUI_NODISCARD std::size_t getTabsCount() const;
 
 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
 bool leftMousePressed(Vector2f pos) override;
 
 void mouseMoved(Vector2f pos) override;
 
 void mouseNoLongerOnWidget() override;
 
 void draw(BackendRenderTarget& target, RenderStates states) const override;
 
 protected:
 
 TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
 // Recalculates the size of each tab image.
 void recalculateTabsWidth();
 
 // Update the colors of the text that is drawn on the tabs
 void updateTextColors();
 
 void rendererChanged(const String& property) override;
 
 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 void updateTextSize() override;
 
 // Makes a copy of the widget
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 public:
 
 SignalString onTabSelect = {"TabSelected"}; 
 
 protected:
 
 float m_maximumTabWidth = 0;
 float m_minimumTabWidth = 0;
 int m_selectedTab = -1;
 int m_hoveringTab = -1;
 bool m_autoSize = true;
 
 struct Tab
 {
 bool visible;
 bool enabled;
 float width;
 Text text;
 };
 std::vector<Tab> m_tabs;
 
 Sprite m_spriteTab;
 Sprite m_spriteTabHover;
 Sprite m_spriteSelectedTab;
 Sprite m_spriteSelectedTabHover;
 Sprite m_spriteDisabledTab;
 
 // Cached renderer properties
 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;
 
 };
 
}
 
 
#endif // TGUI_TAB_HPP