juce_TabbedComponent.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  TabbedComponent  : public Component
{
public:
    //==============================================================================
    explicit TabbedComponent (TabbedButtonBar::Orientation orientation);

    ~TabbedComponent() override;
 
    //==============================================================================
    void setOrientation (TabbedButtonBar::Orientation orientation);

    TabbedButtonBar::Orientation getOrientation() const noexcept;

    void setTabBarDepth (int newDepth);

    int getTabBarDepth() const noexcept                         { return tabDepth; }

    void setOutline (int newThickness);

    void setIndent (int indentThickness);
 
    //==============================================================================
    void clearTabs();

    void addTab (const String& tabName,
                 Colour tabBackgroundColour,
                 Component* contentComponent,
                 bool deleteComponentWhenNotNeeded,
                 int insertIndex = -1);

    void setTabName (int tabIndex, const String& newName);

    void removeTab (int tabIndex);

    void moveTab (int currentIndex, int newIndex, bool animate = false);

    int getNumTabs() const;

    StringArray getTabNames() const;

    Component* getTabContentComponent (int tabIndex) const noexcept;

    Colour getTabBackgroundColour (int tabIndex) const noexcept;

    void setTabBackgroundColour (int tabIndex, Colour newColour);
 
    //==============================================================================
    void setCurrentTabIndex (int newTabIndex, bool sendChangeMessage = true);

    int getCurrentTabIndex() const;

    String getCurrentTabName() const;

    Component* getCurrentContentComponent() const noexcept          { return panelComponent.get(); }
 
    //==============================================================================
    virtual void currentTabChanged (int newCurrentTabIndex, const String& newCurrentTabName);

    virtual void popupMenuClickOnTab (int tabIndex, const String& tabName);

    TabbedButtonBar& getTabbedButtonBar() const noexcept            { return *tabs; }
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId          = 0x1005800,    
        outlineColourId             = 0x1005801,    
    };
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void lookAndFeelChanged() override;
 
protected:
    //==============================================================================
    virtual TabBarButton* createTabButton (const String& tabName, int tabIndex);

    std::unique_ptr<TabbedButtonBar> tabs;
 
private:
    //==============================================================================
    Array<WeakReference<Component>> contentComponents;
    WeakReference<Component> panelComponent;
    int tabDepth = 30, outlineThickness = 1, edgeIndent = 0;
 
    struct ButtonBar;
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void changeCallback (int newCurrentTabIndex, const String& newTabName);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TabbedComponent)
};
 
} // namespace juce