juce_Label.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_LABEL_H_INCLUDED
#define JUCE_LABEL_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  Label  : public Component,
                         public SettableTooltipClient,
                         protected TextEditorListener,
                         private ComponentListener,
                         private ValueListener
{
public:
    //==============================================================================
    Label (const String& componentName = String::empty,
           const String& labelText = String::empty);
 
    ~Label();
 
    //==============================================================================
    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() {}
 
        virtual void labelTextChanged (Label* labelThatHasChanged) = 0;
 
        virtual void editorShown (Label*, TextEditor&) {}
 
        virtual void editorHidden (Label*, TextEditor&) {}
    };
 
    void addListener (Listener* listener);
 
    void removeListener (Listener* listener);
 
    //==============================================================================
    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() {}
 
        virtual void drawLabel (Graphics&, Label&) = 0;
        virtual Font getLabelFont (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;
    KeyboardFocusTraverser* createFocusTraverser() 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;
    Justification justification;
    ScopedPointer<TextEditor> editor;
    ListenerList<Listener> listeners;
    WeakReference<Component> ownerComponent;
    BorderSize<int> border;
    float minimumHorizontalScale;
    TextInputTarget::VirtualKeyboardType keyboardType;
    bool editSingleClick;
    bool editDoubleClick;
    bool lossOfFocusDiscardsChanges;
    bool leftOfOwnerComp;
 
    bool updateFromTextEditorContents (TextEditor&);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Label)
};
 
typedef Label::Listener LabelListener;
 
#endif   // JUCE_LABEL_H_INCLUDED