juce_PropertyComponent.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_PROPERTYCOMPONENT_H_INCLUDED
#define JUCE_PROPERTYCOMPONENT_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  PropertyComponent  : public Component,
                                     public SettableTooltipClient
{
public:
    //==============================================================================
    PropertyComponent (const String& propertyName,
                       int preferredHeight = 25);
 
    ~PropertyComponent();
 
    //==============================================================================
    int getPreferredHeight() const noexcept                 { return preferredHeight; }
 
    void setPreferredHeight (int newHeight) noexcept        { preferredHeight = newHeight; }
 
    //==============================================================================
    virtual void refresh() = 0;
 
 
    void paint (Graphics&) override;
 
    void resized() override;
 
    void enablementChanged() override;
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId     = 0x1008300,    
        labelTextColourId      = 0x1008301,    
    };
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() {}
 
        virtual void drawPropertyPanelSectionHeader (Graphics&, const String& name, bool isOpen, int width, int height) = 0;
        virtual void drawPropertyComponentBackground (Graphics&, int width, int height, PropertyComponent&) = 0;
        virtual void drawPropertyComponentLabel (Graphics&, int width, int height, PropertyComponent&) = 0;
        virtual Rectangle<int> getPropertyComponentContentPosition (PropertyComponent&) = 0;
    };
 
protected:
    int preferredHeight;
 
private:
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PropertyComponent)
};
 
 
#endif   // JUCE_PROPERTYCOMPONENT_H_INCLUDED