JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
Label Class Reference

A component that displays a text string, and can optionally become a text editor when clicked. More...

Inherits Component, SettableTooltipClient, TextEditor::Listener, ComponentListener, and Value::Listener.

Classes

class  Listener
 A class for receiving events from a Label. More...
 
struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes to provide label drawing functionality. More...
 

Public Types

enum  ColourIds { backgroundColourId = 0x1000280, textColourId = 0x1000281, outlineColourId = 0x1000282 }
 A set of colour IDs to use to change the colour of various aspects of the label. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 Label (const String &componentName=String::empty, const String &labelText=String::empty)
 Creates a Label.
 
 ~Label ()
 Destructor.
 
void setText (const String &newText, NotificationType notification)
 Changes the label text.
 
String getText (bool returnActiveEditorContents=false) const
 Returns the label's current text.
 
ValuegetTextValue ()
 Returns the text content as a Value object.
 
void setFont (const Font &newFont)
 Changes the font to use to draw the text.
 
Font getFont () const noexcept
 Returns the font currently being used.
 
void setJustificationType (Justification justification)
 Sets the style of justification to be used for positioning the text.
 
Justification getJustificationType () const noexcept
 Returns the type of justification, as set in setJustificationType().
 
void setBorderSize (int horizontalBorder, int verticalBorder)
 Changes the gap that is left between the edge of the component and the text.
 
int getHorizontalBorderSize () const noexcept
 Returns the size of the horizontal gap being left around the text.
 
int getVerticalBorderSize () const noexcept
 Returns the size of the vertical gap being left around the text.
 
void attachToComponent (Component *owner, bool onLeft)
 Makes this label "stick to" another component.
 
ComponentgetAttachedComponent () const
 If this label has been attached to another component using attachToComponent, this returns the other component.
 
bool isAttachedOnLeft () const noexcept
 If the label is attached to the left of another component, this returns true.
 
void setMinimumHorizontalScale (float newScale)
 Specifies the minimum amount that the font can be squashed horizantally before it starts using ellipsis.
 
float getMinimumHorizontalScale () const noexcept
 
void addListener (Listener *listener)
 Registers a listener that will be called when the label's text changes.
 
void removeListener (Listener *listener)
 Deregisters a previously-registered listener.
 
void setEditable (bool editOnSingleClick, bool editOnDoubleClick=false, bool lossOfFocusDiscardsChanges=false)
 Makes the label turn into a TextEditor when clicked.
 
bool isEditableOnSingleClick () const noexcept
 Returns true if this option was set using setEditable().
 
bool isEditableOnDoubleClick () const noexcept
 Returns true if this option was set using setEditable().
 
bool doesLossOfFocusDiscardChanges () const noexcept
 Returns true if this option has been set in a call to setEditable().
 
bool isEditable () const noexcept
 Returns true if the user can edit this label's text.
 
void showEditor ()
 Makes the editor appear as if the label had been clicked by the user.
 
void hideEditor (bool discardCurrentEditorContents)
 Hides the editor if it was being shown.
 
bool isBeingEdited () const noexcept
 Returns true if the editor is currently focused and active.
 
TextEditorgetCurrentTextEditor () const noexcept
 Returns the currently-visible text editor, or nullptr if none is open.
 
- Public Member Functions inherited from Component
 Component ()
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName)
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
virtual void visibilityChanged ()
 Called when this component's visibility changes.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
void getVisibleArea (RectangleList< int > &result, bool includeSiblings) const
 Returns the region of this component that's not obscured by other, opaque components.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
virtual void mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed.
 
virtual void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down.
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate that one of this component's children has been focused or unfocused.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor.
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 Destructor.
 
virtual void setTooltip (const String &newTooltip)
 Assigns a new tooltip to this object.
 
virtual String getTooltip ()
 Returns the tooltip assigned to this object.
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 Destructor.
 

Protected Member Functions

virtual TextEditorcreateEditorComponent ()
 Creates the TextEditor component that will be used when the user has clicked on the label.
 
virtual void textWasEdited ()
 Called after the user changes the text.
 
virtual void textWasChanged ()
 Called when the text has been altered.
 
virtual void editorShown (TextEditor *)
 Called when the text editor has just appeared, due to a user click or other focus change.
 
virtual void editorAboutToBeHidden (TextEditor *)
 Called when the text editor is going to be deleted, after editing has finished.
 
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
 
KeyboardFocusTraversercreateFocusTraverser () 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 ()
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 
- Protected Member Functions inherited from TextEditor::Listener
virtual ~Listener ()
 Destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 
- Private Member Functions inherited from ComponentListener
virtual ~ComponentListener ()
 Destructor.
 
virtual void componentBroughtToFront (Component &component)
 Called when the component is brought to the top of the z-order.
 
virtual void componentChildrenChanged (Component &component)
 Called when the component has children added or removed, or their z-order changes.
 
virtual void componentNameChanged (Component &component)
 Called when the component's name is changed.
 
virtual void componentBeingDeleted (Component &component)
 Called when the component is in the process of being deleted.
 
- Private Member Functions inherited from Value::Listener
 Listener ()
 
virtual ~Listener ()
 

Detailed Description

A component that displays a text string, and can optionally become a text editor when clicked.

Member Enumeration Documentation

A set of colour IDs to use to change the colour of various aspects of the label.

These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.

Note that you can also use the constants from TextEditor::ColourIds to change the colour of the text editor that is opened when a label is editable.

See Also
Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
Enumerator:
backgroundColourId 

The background colour to fill the label with.

textColourId 

The colour for the text.

outlineColourId 

An optional colour to use to draw a border around the label.

Leave this transparent to not have an outline.

Constructor & Destructor Documentation

Label::Label ( const String componentName = String::empty,
const String labelText = String::empty 
)

Creates a Label.

Parameters
componentNamethe name to give the component
labelTextthe text to show in the label
Label::~Label ( )

Destructor.

Member Function Documentation

void Label::setText ( const String newText,
NotificationType  notification 
)

Changes the label text.

The NotificationType parameter indicates whether to send a change message to any Label::Listener objects if the new text is different.

String Label::getText ( bool  returnActiveEditorContents = false) const

Returns the label's current text.

Parameters
returnActiveEditorContentsif this is true and the label is currently being edited, then this method will return the text as it's being shown in the editor. If false, then the value returned here won't be updated until the user has finished typing and pressed the return key.
Value& Label::getTextValue ( )

Returns the text content as a Value object.

You can call Value::referTo() on this object to make the label read and control a Value object that you supply.

void Label::setFont ( const Font newFont)

Changes the font to use to draw the text.

See Also
getFont
Font Label::getFont ( ) const
noexcept

Returns the font currently being used.

This may be the one set by setFont(), unless it has been overridden by the current LookAndFeel

See Also
setFont
void Label::setJustificationType ( Justification  justification)

Sets the style of justification to be used for positioning the text.

(The default is Justification::centredLeft)

Justification Label::getJustificationType ( ) const
noexcept

Returns the type of justification, as set in setJustificationType().

void Label::setBorderSize ( int  horizontalBorder,
int  verticalBorder 
)

Changes the gap that is left between the edge of the component and the text.

By default there's a small gap left at the sides of the component to allow for the drawing of the border, but you can change this if necessary.

int Label::getHorizontalBorderSize ( ) const
noexcept

Returns the size of the horizontal gap being left around the text.

int Label::getVerticalBorderSize ( ) const
noexcept

Returns the size of the vertical gap being left around the text.

void Label::attachToComponent ( Component owner,
bool  onLeft 
)

Makes this label "stick to" another component.

This will cause the label to follow another component around, staying either to its left or above it.

Parameters
ownerthe component to follow
onLeftif true, the label will stay on the left of its component; if false, it will stay above it.
Component* Label::getAttachedComponent ( ) const

If this label has been attached to another component using attachToComponent, this returns the other component.

Returns nullptr if the label is not attached.

bool Label::isAttachedOnLeft ( ) const
noexcept

If the label is attached to the left of another component, this returns true.

Returns false if the label is above the other component. This is only relevent if attachToComponent() has been called.

void Label::setMinimumHorizontalScale ( float  newScale)

Specifies the minimum amount that the font can be squashed horizantally before it starts using ellipsis.

See Also
Graphics::drawFittedText
float Label::getMinimumHorizontalScale ( ) const
noexcept
void Label::addListener ( Listener listener)

Registers a listener that will be called when the label's text changes.

void Label::removeListener ( Listener listener)

Deregisters a previously-registered listener.

void Label::setEditable ( bool  editOnSingleClick,
bool  editOnDoubleClick = false,
bool  lossOfFocusDiscardsChanges = false 
)

Makes the label turn into a TextEditor when clicked.

By default this is turned off.

If turned on, then single- or double-clicking will turn the label into an editor. If the user then changes the text, then the ChangeBroadcaster base class will be used to send change messages to any listeners that have registered.

If the user changes the text, the textWasEdited() method will be called afterwards, and subclasses can override this if they need to do anything special.

Parameters
editOnSingleClickif true, just clicking once on the label will start editing the text
editOnDoubleClickif true, a double-click is needed to start editing
lossOfFocusDiscardsChangesif true, clicking somewhere else while the text is being edited will discard any changes; if false, then this will commit the changes.
See Also
showEditor, setEditorColours, TextEditor
bool Label::isEditableOnSingleClick ( ) const
noexcept

Returns true if this option was set using setEditable().

bool Label::isEditableOnDoubleClick ( ) const
noexcept

Returns true if this option was set using setEditable().

bool Label::doesLossOfFocusDiscardChanges ( ) const
noexcept

Returns true if this option has been set in a call to setEditable().

bool Label::isEditable ( ) const
noexcept

Returns true if the user can edit this label's text.

void Label::showEditor ( )

Makes the editor appear as if the label had been clicked by the user.

See Also
textWasEdited, setEditable
void Label::hideEditor ( bool  discardCurrentEditorContents)

Hides the editor if it was being shown.

Parameters
discardCurrentEditorContentsif true, the label's text will be reset to whatever it was before the editor was shown; if false, the current contents of the editor will be used to set the label's text before it is hidden.
bool Label::isBeingEdited ( ) const
noexcept

Returns true if the editor is currently focused and active.

TextEditor* Label::getCurrentTextEditor ( ) const
noexcept

Returns the currently-visible text editor, or nullptr if none is open.

virtual TextEditor* Label::createEditorComponent ( )
protectedvirtual

Creates the TextEditor component that will be used when the user has clicked on the label.

Subclasses can override this if they need to customise this component in some way.

virtual void Label::textWasEdited ( )
protectedvirtual

Called after the user changes the text.

virtual void Label::textWasChanged ( )
protectedvirtual

Called when the text has been altered.

virtual void Label::editorShown ( TextEditor )
protectedvirtual

Called when the text editor has just appeared, due to a user click or other focus change.

virtual void Label::editorAboutToBeHidden ( TextEditor )
protectedvirtual

Called when the text editor is going to be deleted, after editing has finished.

void Label::paint ( Graphics )
overrideprotectedvirtual

Reimplemented from Component.

void Label::resized ( )
overrideprotectedvirtual

Reimplemented from Component.

void Label::mouseUp ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

void Label::mouseDoubleClick ( const MouseEvent )
overrideprotectedvirtual

Reimplemented from Component.

void Label::componentMovedOrResized ( Component ,
bool  wasMoved,
bool  wasResized 
)
overrideprotectedvirtual

Reimplemented from ComponentListener.

void Label::componentParentHierarchyChanged ( Component )
overrideprotectedvirtual

Reimplemented from ComponentListener.

void Label::componentVisibilityChanged ( Component )
overrideprotectedvirtual

Reimplemented from ComponentListener.

void Label::inputAttemptWhenModal ( )
overrideprotectedvirtual

Reimplemented from Component.

void Label::focusGained ( FocusChangeType  )
overrideprotectedvirtual

Reimplemented from Component.

void Label::enablementChanged ( )
overrideprotectedvirtual

Reimplemented from Component.

KeyboardFocusTraverser* Label::createFocusTraverser ( )
overrideprotectedvirtual

Reimplemented from Component.

void Label::textEditorTextChanged ( TextEditor )
overrideprotectedvirtual

Reimplemented from TextEditor::Listener.

void Label::textEditorReturnKeyPressed ( TextEditor )
overrideprotectedvirtual

Reimplemented from TextEditor::Listener.

void Label::textEditorEscapeKeyPressed ( TextEditor )
overrideprotectedvirtual

Reimplemented from TextEditor::Listener.

void Label::textEditorFocusLost ( TextEditor )
overrideprotectedvirtual

Reimplemented from TextEditor::Listener.

void Label::colourChanged ( )
overrideprotectedvirtual

Reimplemented from Component.

void Label::valueChanged ( Value )
overrideprotectedvirtual

Implements Value::Listener.

void Label::callChangeListeners ( )
protected

The documentation for this class was generated from the following file: