juce_TabbedButtonBar.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 TabbedButtonBar;
 
 
//==============================================================================
class JUCE_API  TabBarButton  : public Button
{
public:
    //==============================================================================
    TabBarButton (const String& name, TabbedButtonBar& ownerBar);

    ~TabBarButton() override;

    TabbedButtonBar& getTabbedButtonBar() const   { return owner; }
 
    //==============================================================================
    enum ExtraComponentPlacement
    {
        beforeText,
        afterText
    };

    void setExtraComponent (Component* extraTabComponent,
                            ExtraComponentPlacement extraComponentPlacement);

    Component* getExtraComponent() const noexcept                           { return extraComponent.get(); }

    ExtraComponentPlacement getExtraComponentPlacement() const noexcept     { return extraCompPlacement; }

    Rectangle<int> getActiveArea() const;

    Rectangle<int> getTextArea() const;

    int getIndex() const;

    Colour getTabBackgroundColour() const;

    bool isFrontTab() const;
 
    //==============================================================================
    virtual int getBestTabLength (int depth);
 
    //==============================================================================
    void paintButton (Graphics&, bool, bool) override;
    void clicked (const ModifierKeys&) override;
    bool hitTest (int x, int y) override;
    void resized() override;
    void childBoundsChanged (Component*) override;
 
protected:
    friend class TabbedButtonBar;
    TabbedButtonBar& owner;
    int overlapPixels = 0;
 
    std::unique_ptr<Component> extraComponent;
    ExtraComponentPlacement extraCompPlacement = afterText;
 
private:
    using Button::clicked;
    void calcAreas (Rectangle<int>&, Rectangle<int>&) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TabBarButton)
};
 
 
//==============================================================================
class JUCE_API  TabbedButtonBar  : public Component,
                                   public ChangeBroadcaster
{
public:
    //==============================================================================
    enum Orientation
    {
        TabsAtTop,
        TabsAtBottom,
        TabsAtLeft,
        TabsAtRight
    };
 
    //==============================================================================
    TabbedButtonBar (Orientation orientation);

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

    Orientation getOrientation() const noexcept         { return orientation; }

    bool isVertical() const noexcept                    { return orientation == TabsAtLeft || orientation == TabsAtRight; }

    int getThickness() const noexcept                   { return isVertical() ? getWidth() : getHeight(); }

    void setMinimumTabScaleFactor (double newMinimumScale);
 
    //==============================================================================
    void clearTabs();

    void addTab (const String& tabName,
                 Colour tabBackgroundColour,
                 int insertIndex);

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

    void removeTab (int tabIndex, bool animate = false);

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

    int getNumTabs() const;

    StringArray getTabNames() const;

    void setCurrentTabIndex (int newTabIndex, bool sendChangeMessage = true);

    String getCurrentTabName() const;

    int getCurrentTabIndex() const noexcept             { return currentTabIndex; }

    TabBarButton* getTabButton (int index) const;

    int indexOfTabButton (const TabBarButton* button) const;

    Rectangle<int> getTargetBounds (TabBarButton* button) const;
 
    //==============================================================================
    virtual void currentTabChanged (int newCurrentTabIndex,
                                    const String& newCurrentTabName);

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

    Colour getTabBackgroundColour (int tabIndex);

    void setTabBackgroundColour (int tabIndex, Colour newColour);
 
    //==============================================================================
    enum ColourIds
    {
        tabOutlineColourId              = 0x1005812,    
        tabTextColourId                 = 0x1005813,    
        frontOutlineColourId            = 0x1005814,    
        frontTextColourId               = 0x1005815,    
    };
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual int getTabButtonSpaceAroundImage() = 0;
        virtual int getTabButtonOverlap (int tabDepth) = 0;
        virtual int getTabButtonBestWidth (TabBarButton&, int tabDepth) = 0;
        virtual Rectangle<int> getTabButtonExtraComponentBounds (const TabBarButton&, Rectangle<int>& textArea, Component& extraComp) = 0;
 
        virtual void drawTabButton (TabBarButton&, Graphics&, bool isMouseOver, bool isMouseDown) = 0;
        virtual Font getTabButtonFont (TabBarButton&, float height) = 0;
        virtual void drawTabButtonText (TabBarButton&, Graphics&, bool isMouseOver, bool isMouseDown) = 0;
        virtual void drawTabbedButtonBarBackground (TabbedButtonBar&, Graphics&) = 0;
        virtual void drawTabAreaBehindFrontButton (TabbedButtonBar&, Graphics&, int w, int h) = 0;
 
        virtual void createTabButtonShape (TabBarButton&, Path& path,  bool isMouseOver, bool isMouseDown) = 0;
        virtual void fillTabButtonShape (TabBarButton&, Graphics&, const Path& path, bool isMouseOver, bool isMouseDown) = 0;
 
        virtual Button* createTabBarExtrasButton() = 0;
    };
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void lookAndFeelChanged() override;
 
protected:
    //==============================================================================
    virtual TabBarButton* createTabButton (const String& tabName, int tabIndex);
 
private:
    struct TabInfo
    {
        std::unique_ptr<TabBarButton> button;
        String name;
        Colour colour;
    };
 
    OwnedArray<TabInfo> tabs;
 
    Orientation orientation;
    double minimumScale = 0.7;
    int currentTabIndex = -1;
 
    class BehindFrontTabComp;
    std::unique_ptr<BehindFrontTabComp> behindFrontTab;
    std::unique_ptr<Button> extraTabsButton;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void showExtraItemsMenu();
    void updateTabPositions (bool animate);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TabbedButtonBar)
};
 
} // namespace juce