juce_ToolbarItemComponent.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  ToolbarItemComponent  : public Button
{
public:
    //==============================================================================
    ToolbarItemComponent (int itemId,
                          const String& labelText,
                          bool isBeingUsedAsAButton);

    ~ToolbarItemComponent() override;
 
    //==============================================================================
    int getItemId() const noexcept                                  { return itemId; }

    Toolbar* getToolbar() const;

    bool isToolbarVertical() const;

    Toolbar::ToolbarItemStyle getStyle() const noexcept             { return toolbarStyle; }

    virtual void setStyle (const Toolbar::ToolbarItemStyle& newStyle);

    Rectangle<int> getContentArea() const noexcept                  { return contentArea; }
 
    //==============================================================================
    virtual bool getToolbarItemSizes (int toolbarThickness,
                                      bool isToolbarVertical,
                                      int& preferredSize,
                                      int& minSize,
                                      int& maxSize) = 0;

    virtual void paintButtonArea (Graphics& g,
                                  int width, int height,
                                  bool isMouseOver, bool isMouseDown) = 0;

    virtual void contentAreaChanged (const Rectangle<int>& newBounds) = 0;
 
 
    //==============================================================================
    enum ToolbarEditingMode
    {
        normalMode = 0,     
        editableOnToolbar,  
        editableOnPalette   
    };

    void setEditingMode (const ToolbarEditingMode newMode);

    ToolbarEditingMode getEditingMode() const noexcept                  { return mode; }
 
 
    //==============================================================================
    void paintButton (Graphics&, bool isMouseOver, bool isMouseDown) override;
    void resized() override;
 
private:
    friend class Toolbar;
    class ItemDragAndDropOverlayComponent;
    friend class ItemDragAndDropOverlayComponent;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
 
    const int itemId;
    ToolbarEditingMode mode;
    Toolbar::ToolbarItemStyle toolbarStyle;
    std::unique_ptr<Component> overlayComp;
    int dragOffsetX, dragOffsetY;
    bool isActive, isBeingDragged, isBeingUsedAsAButton;
    Rectangle<int> contentArea;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ToolbarItemComponent)
};
 
} // namespace juce