juce_Toolbar.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 ToolbarItemComponent;
class ToolbarItemFactory;
 
 
//==============================================================================
class JUCE_API  Toolbar   : public Component,
                            public DragAndDropContainer,
                            public DragAndDropTarget
{
public:
    //==============================================================================
    Toolbar();

    ~Toolbar() override;
 
    //==============================================================================
    void setVertical (bool shouldBeVertical);

    bool isVertical() const noexcept                 { return vertical; }

    int getThickness() const noexcept;

    int getLength() const noexcept;
 
    //==============================================================================
    void clear();

    void addItem (ToolbarItemFactory& factory,
                  int itemId,
                  int insertIndex = -1);

    void removeToolbarItem (int itemIndex);

    ToolbarItemComponent* removeAndReturnItem (int itemIndex);

    int getNumItems() const noexcept;

    int getItemId (int itemIndex) const noexcept;

    ToolbarItemComponent* getItemComponent (int itemIndex) const noexcept;

    void addDefaultItems (ToolbarItemFactory& factoryToUse);
 
    //==============================================================================
    enum ToolbarItemStyle
    {
        iconsOnly,       
        iconsWithText,   
        textOnly         
    };

    ToolbarItemStyle getStyle() const noexcept               { return toolbarStyle; }

    void setStyle (const ToolbarItemStyle& newStyle);
 
    //==============================================================================
    enum CustomisationFlags
    {
        allowIconsOnlyChoice            = 1,    
        allowIconsWithTextChoice        = 2,    
        allowTextOnlyChoice             = 4,    
        showResetToDefaultsButton       = 8,    
 
        allCustomisationOptionsEnabled = (allowIconsOnlyChoice | allowIconsWithTextChoice | allowTextOnlyChoice | showResetToDefaultsButton)
    };

    void showCustomisationDialog (ToolbarItemFactory& factory,
                                  int optionFlags = allCustomisationOptionsEnabled);

    void setEditingActive (bool editingEnabled);
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId          = 0x1003200,  
        separatorColourId           = 0x1003210,  
 
        buttonMouseOverBackgroundColourId = 0x1003220,  
        buttonMouseDownBackgroundColourId = 0x1003230,  
 
        labelTextColourId           = 0x1003240,        
 
        editingModeOutlineColourId  = 0x1003250   
    };
 
    //==============================================================================
    String toString() const;

    bool restoreFromString (ToolbarItemFactory& factoryToUse,
                            const String& savedVersion);
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual void paintToolbarBackground (Graphics&, int width, int height, Toolbar&) = 0;
 
        virtual Button* createToolbarMissingItemsButton (Toolbar&) = 0;
 
        virtual void paintToolbarButtonBackground (Graphics&, int width, int height,
                                                   bool isMouseOver, bool isMouseDown,
                                                   ToolbarItemComponent&) = 0;
 
        virtual void paintToolbarButtonLabel (Graphics&, int x, int y, int width, int height,
                                              const String& text, ToolbarItemComponent&) = 0;
    };
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void mouseDown (const MouseEvent&) override;
    bool isInterestedInDragSource (const SourceDetails&) override;
    void itemDragMove (const SourceDetails&) override;
    void itemDragExit (const SourceDetails&) override;
    void itemDropped (const SourceDetails&) override;
    void lookAndFeelChanged() override;
    void updateAllItemPositions (bool animate);
    static ToolbarItemComponent* createItem (ToolbarItemFactory&, int itemId);
    static const char* const toolbarDragDescriptor;
 
private:
    //==============================================================================
    std::unique_ptr<Button> missingItemsButton;
    bool vertical = false, isEditingActive = false;
    ToolbarItemStyle toolbarStyle = iconsOnly;
    class MissingItemsComponent;
    friend class MissingItemsComponent;
    OwnedArray<ToolbarItemComponent> items;
    class Spacer;
    class CustomisationDialog;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void initMissingItemButton();
    void showMissingItems();
    void addItemInternal (ToolbarItemFactory& factory, int itemId, int insertIndex);
 
    ToolbarItemComponent* getNextActiveComponent (int index, int delta) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Toolbar)
};
 
} // namespace juce