juce_TextPropertyComponent.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  TextPropertyComponent  : public PropertyComponent
{
protected:
    //==============================================================================
    TextPropertyComponent (const String& propertyName,
                           int maxNumChars,
                           bool isMultiLine,
                           bool isEditable = true);
 
public:
    TextPropertyComponent (const Value& valueToControl,
                           const String& propertyName,
                           int maxNumChars,
                           bool isMultiLine,
                           bool isEditable = true);

    TextPropertyComponent (const ValueTreePropertyWithDefault& valueToControl,
                           const String& propertyName,
                           int maxNumChars,
                           bool isMultiLine,
                           bool isEditable = true);
 
    ~TextPropertyComponent() override;
 
    //==============================================================================
    virtual void setText (const String& newText);

    virtual String getText() const;

    Value& getValue() const;
 
    //==============================================================================
    bool isTextEditorMultiLine() const noexcept    { return isMultiLine; }
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId          = 0x100e401,    
        textColourId                = 0x100e402,    
        outlineColourId             = 0x100e403,    
    };
 
    void colourChanged() override;
 
    //==============================================================================
    class JUCE_API Listener
    {
    public:
        virtual ~Listener() = default;

        virtual void textPropertyComponentChanged (TextPropertyComponent*) = 0;
    };

    void addListener (Listener* newListener);

    void removeListener (Listener* listener);
 
    //==============================================================================
    void setInterestedInFileDrag (bool isInterested);

    void setEditable (bool isEditable);
 
    //==============================================================================
    void refresh() override;
    virtual void textWasEdited();
 
private:
    //==============================================================================
    void callListeners();
    void createEditor (int maxNumChars, bool isEditable);
 
    //==============================================================================
    class LabelComp;
 
    const bool isMultiLine;
 
    ValueTreePropertyWithDefault value;
    std::unique_ptr<LabelComp> textEditor;
    ListenerList<Listener> listenerList;
 
    //==============================================================================
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TextPropertyComponent)
};
 
 
} // namespace juce