juce_Label.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  Label  : public Component,
                         public SettableTooltipClient,
                         protected TextEditor::Listener,
                         private ComponentListener,
                         private Value::Listener
{
public:
    //==============================================================================
    Label (const String& componentName = String(),
           const String& labelText = String());

    ~Label() override;
 
    //==============================================================================
    void setText (const String& newText,
                  NotificationType notification);

    String getText (bool returnActiveEditorContents = false) const;

    Value& getTextValue() noexcept                          { return textValue; }
 
    //==============================================================================
    void setFont (const Font& newFont);

    Font getFont() const noexcept;
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId             = 0x1000280, 
        textColourId                   = 0x1000281, 
        outlineColourId                = 0x1000282, 
        backgroundWhenEditingColourId  = 0x1000283, 
        textWhenEditingColourId        = 0x1000284, 
        outlineWhenEditingColourId     = 0x1000285  
    };
 
    //==============================================================================
    void setJustificationType (Justification justification);

    Justification getJustificationType() const noexcept                         { return justification; }

    void setBorderSize (BorderSize<int> newBorderSize);

    BorderSize<int> getBorderSize() const noexcept                              { return border; }

    void attachToComponent (Component* owner, bool onLeft);

    Component* getAttachedComponent() const;

    bool isAttachedOnLeft() const noexcept                                      { return leftOfOwnerComp; }

    void setMinimumHorizontalScale (float newScale);

    float getMinimumHorizontalScale() const noexcept                            { return minimumHorizontalScale; }

    void setKeyboardType (TextInputTarget::VirtualKeyboardType type) noexcept   { keyboardType = type; }
 
    //==============================================================================
    class JUCE_API  Listener
    {
    public:
        virtual ~Listener() = default;

        virtual void labelTextChanged (Label* labelThatHasChanged) = 0;

        virtual void editorShown (Label*, TextEditor&) {}

        virtual void editorHidden (Label*, TextEditor&) {}
    };

    void addListener (Listener* listener);

    void removeListener (Listener* listener);
 
    //==============================================================================
    std::function<void()> onTextChange;

    std::function<void()> onEditorShow;

    std::function<void()> onEditorHide;
 
    //==============================================================================
    void setEditable (bool editOnSingleClick,
                      bool editOnDoubleClick = false,
                      bool lossOfFocusDiscardsChanges = false);

    bool isEditableOnSingleClick() const noexcept                       { return editSingleClick; }

    bool isEditableOnDoubleClick() const noexcept                       { return editDoubleClick; }

    bool doesLossOfFocusDiscardChanges() const noexcept                 { return lossOfFocusDiscardsChanges; }

    bool isEditable() const noexcept                                    { return editSingleClick || editDoubleClick; }

    void showEditor();

    void hideEditor (bool discardCurrentEditorContents);

    bool isBeingEdited() const noexcept;

    TextEditor* getCurrentTextEditor() const noexcept;
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual void drawLabel (Graphics&, Label&) = 0;
        virtual Font getLabelFont (Label&) = 0;
        virtual BorderSize<int> getLabelBorderSize (Label&) = 0;
    };
 
protected:
    //==============================================================================
    virtual TextEditor* createEditorComponent();

    virtual void textWasEdited();

    virtual void textWasChanged();

    virtual void editorShown (TextEditor*);

    virtual void editorAboutToBeHidden (TextEditor*);
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void mouseUp (const MouseEvent&) override;
    void mouseDoubleClick (const MouseEvent&) override;
    void componentMovedOrResized (Component&, bool wasMoved, bool wasResized) override;
    void componentParentHierarchyChanged (Component&) override;
    void componentVisibilityChanged (Component&) override;
    void inputAttemptWhenModal() override;
    void focusGained (FocusChangeType) override;
    void enablementChanged() override;
    std::unique_ptr<ComponentTraverser> createKeyboardFocusTraverser() override;
    void textEditorTextChanged (TextEditor&) override;
    void textEditorReturnKeyPressed (TextEditor&) override;
    void textEditorEscapeKeyPressed (TextEditor&) override;
    void textEditorFocusLost (TextEditor&) override;
    void colourChanged() override;
    void valueChanged (Value&) override;
    void callChangeListeners();
 
private:
    //==============================================================================
    Value textValue;
    String lastTextValue;
    Font font { 15.0f };
    Justification justification = Justification::centredLeft;
    std::unique_ptr<TextEditor> editor;
    ListenerList<Listener> listeners;
    WeakReference<Component> ownerComponent;
    BorderSize<int> border { 1, 5, 1, 5 };
    float minimumHorizontalScale = 0;
    TextInputTarget::VirtualKeyboardType keyboardType = TextInputTarget::textKeyboard;
    bool editSingleClick = false;
    bool editDoubleClick = false;
    bool lossOfFocusDiscardsChanges = false;
    bool leftOfOwnerComp = false;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    bool updateFromTextEditorContents (TextEditor&);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Label)
};
 
 
} // namespace juce