juce_PropertyPanel.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  PropertyPanel  : public Component
{
public:
    //==============================================================================
    PropertyPanel();

    PropertyPanel (const String& name);

    ~PropertyPanel() override;
 
    //==============================================================================
    void clear();

    void addProperties (const Array<PropertyComponent*>& newPropertyComponents,
                        int extraPaddingBetweenComponents = 0);

    void addSection (const String& sectionTitle,
                     const Array<PropertyComponent*>& newPropertyComponents,
                     bool shouldSectionInitiallyBeOpen = true,
                     int indexToInsertAt = -1,
                     int extraPaddingBetweenComponents = 0);

    void refreshAll() const;

    bool isEmpty() const;

    int getTotalContentHeight() const;
 
    //==============================================================================
    StringArray getSectionNames() const;

    bool isSectionOpen (int sectionIndex) const;

    void setSectionOpen (int sectionIndex, bool shouldBeOpen);

    void setSectionEnabled (int sectionIndex, bool shouldBeEnabled);

    void removeSection (int sectionIndex);
 
    //==============================================================================
    std::unique_ptr<XmlElement> getOpennessState() const;

    void restoreOpennessState (const XmlElement& newState);
 
    //==============================================================================
    void setMessageWhenEmpty (const String& newMessage);

    const String& getMessageWhenEmpty() const noexcept;
 
    //==============================================================================
    Viewport& getViewport() noexcept        { return viewport; }
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
 
private:
    Viewport viewport;
    struct SectionComponent;
    struct PropertyHolderComponent;
    PropertyHolderComponent* propertyHolderComponent;
    String messageWhenEmpty;
 
    void init();
    void updatePropHolderLayout() const;
    void updatePropHolderLayout (int width) const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PropertyPanel)
};
 
} // namespace juce