LMMS
Loading...
Searching...
No Matches
juce::TextPropertyComponent::LabelComp Class Reference
Inheritance diagram for juce::TextPropertyComponent::LabelComp:
juce::Label juce::FileDragAndDropTarget juce::Component juce::SettableTooltipClient juce::TextEditor::Listener juce::ComponentListener juce::Value::Listener juce::MouseListener juce::TooltipClient

Public Member Functions

 LabelComp (TextPropertyComponent &tpc, int charLimit, bool multiline, bool editable)
bool isInterestedInFileDrag (const StringArray &) override
void filesDropped (const StringArray &files, int, int) override
TextEditorcreateEditorComponent () override
void textWasEdited () override
void updateColours ()
void setInterestedInFileDrag (bool isInterested)
void setTextToDisplayWhenEmpty (const String &text, float alpha)
void paintOverChildren (Graphics &g) override
Public Member Functions inherited from juce::Label
 Label (const String &componentName=String(), const String &labelText=String())
 ~Label () override
void setText (const String &newText, NotificationType notification)
String getText (bool returnActiveEditorContents=false) const
ValuegetTextValue () noexcept
void setFont (const Font &newFont)
Font getFont () const noexcept
void setJustificationType (Justification justification)
Justification getJustificationType () const noexcept
void setBorderSize (BorderSize< int > newBorderSize)
BorderSize< intgetBorderSize () const noexcept
void attachToComponent (Component *owner, bool onLeft)
ComponentgetAttachedComponent () const
bool isAttachedOnLeft () const noexcept
void setMinimumHorizontalScale (float newScale)
float getMinimumHorizontalScale () const noexcept
void setKeyboardType (TextInputTarget::VirtualKeyboardType type) noexcept
void addListener (Listener *listener)
void removeListener (Listener *listener)
void setEditable (bool editOnSingleClick, bool editOnDoubleClick=false, bool lossOfFocusDiscardsChanges=false)
bool isEditableOnSingleClick () const noexcept
bool isEditableOnDoubleClick () const noexcept
bool doesLossOfFocusDiscardChanges () const noexcept
bool isEditable () const noexcept
void showEditor ()
void hideEditor (bool discardCurrentEditorContents)
bool isBeingEdited () const noexcept
TextEditorgetCurrentTextEditor () const noexcept
Public Member Functions inherited from juce::Component
 Component () noexcept
 ~Component () override
 Component (const String &componentName) noexcept
String getName () const noexcept
virtual void setName (const String &newName)
String getComponentID () const noexcept
void setComponentID (const String &newID)
virtual void setVisible (bool shouldBeVisible)
bool isVisible () const noexcept
virtual void visibilityChanged ()
bool isShowing () const
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
void removeFromDesktop ()
bool isOnDesktop () const noexcept
ComponentPeergetPeer () const
virtual void userTriedToCloseWindow ()
virtual void minimisationStateChanged (bool isNowMinimised)
virtual float getDesktopScaleFactor () const
void toFront (bool shouldAlsoGainKeyboardFocus)
void toBack ()
void toBehind (Component *other)
void setAlwaysOnTop (bool shouldStayOnTop)
bool isAlwaysOnTop () const noexcept
int getX () const noexcept
int getY () const noexcept
int getWidth () const noexcept
int getHeight () const noexcept
int getRight () const noexcept
Point< intgetPosition () const noexcept
int getBottom () const noexcept
Rectangle< intgetBounds () const noexcept
Rectangle< intgetLocalBounds () const noexcept
Rectangle< intgetBoundsInParent () const noexcept
int getScreenX () const
int getScreenY () const
Point< intgetScreenPosition () const
Rectangle< intgetScreenBounds () const
Point< intgetLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
Rectangle< intgetLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
Rectangle< float > getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
Point< intlocalPointToGlobal (Point< int > localPoint) const
Point< float > localPointToGlobal (Point< float > localPoint) const
Rectangle< intlocalAreaToGlobal (Rectangle< int > localArea) const
Rectangle< float > localAreaToGlobal (Rectangle< float > localArea) const
void setTopLeftPosition (int x, int y)
void setTopLeftPosition (Point< int > newTopLeftPosition)
void setTopRightPosition (int x, int y)
void setSize (int newWidth, int newHeight)
void setBounds (int x, int y, int width, int height)
void setBounds (Rectangle< int > newBounds)
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
void setBoundsRelative (Rectangle< float > proportionalArea)
void setBoundsInset (BorderSize< int > borders)
void setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
void setCentrePosition (int x, int y)
void setCentrePosition (Point< int > newCentrePosition)
void setCentreRelative (float x, float y)
void centreWithSize (int width, int height)
void setTransform (const AffineTransform &transform)
AffineTransform getTransform () const
bool isTransformed () const noexcept
int proportionOfWidth (float proportion) const noexcept
int proportionOfHeight (float proportion) const noexcept
int getParentWidth () const noexcept
int getParentHeight () const noexcept
Rectangle< intgetParentMonitorArea () const
int getNumChildComponents () const noexcept
ComponentgetChildComponent (int index) const noexcept
int getIndexOfChildComponent (const Component *child) const noexcept
const Array< Component * > & getChildren () const noexcept
ComponentfindChildWithID (StringRef componentID) const noexcept
void addChildComponent (Component *child, int zOrder=-1)
void addChildComponent (Component &child, int zOrder=-1)
void addAndMakeVisible (Component *child, int zOrder=-1)
void addAndMakeVisible (Component &child, int zOrder=-1)
void addChildAndSetID (Component *child, const String &componentID)
void removeChildComponent (Component *childToRemove)
ComponentremoveChildComponent (int childIndexToRemove)
void removeAllChildren ()
void deleteAllChildren ()
ComponentgetParentComponent () const noexcept
template<class TargetClass>
TargetClass * findParentComponentOfClass () const
ComponentgetTopLevelComponent () const noexcept
bool isParentOf (const Component *possibleChild) const noexcept
virtual void parentHierarchyChanged ()
virtual void childrenChanged ()
virtual bool hitTest (int x, int y)
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
bool contains (Point< int > localPoint)
bool contains (Point< float > localPoint)
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
bool reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild)
ComponentgetComponentAt (int x, int y)
ComponentgetComponentAt (Point< int > position)
ComponentgetComponentAt (Point< float > position)
void repaint ()
void repaint (int x, int y, int width, int height)
void repaint (Rectangle< int > area)
void setBufferedToImage (bool shouldBeBuffered)
Image createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
bool isPaintingUnclipped () const noexcept
void setComponentEffect (ImageEffectFilter *newEffect)
ImageEffectFiltergetComponentEffect () const noexcept
LookAndFeelgetLookAndFeel () const noexcept
void setLookAndFeel (LookAndFeel *newLookAndFeel)
virtual void lookAndFeelChanged ()
void sendLookAndFeelChange ()
void setOpaque (bool shouldBeOpaque)
bool isOpaque () const noexcept
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
bool isBroughtToFrontOnMouseClick () const noexcept
void setExplicitFocusOrder (int newFocusOrderIndex)
int getExplicitFocusOrder () const
void setFocusContainerType (FocusContainerType containerType) noexcept
bool isFocusContainer () const noexcept
bool isKeyboardFocusContainer () const noexcept
ComponentfindFocusContainer () const
ComponentfindKeyboardFocusContainer () const
void setWantsKeyboardFocus (bool wantsFocus) noexcept
bool getWantsKeyboardFocus () const noexcept
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
bool getMouseClickGrabsKeyboardFocus () const noexcept
void grabKeyboardFocus ()
void giveAwayKeyboardFocus ()
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
void moveKeyboardFocusToSibling (bool moveToNext)
virtual std::unique_ptr< ComponentTraversercreateFocusTraverser ()
void setHasFocusOutline (bool hasFocusOutline) noexcept
bool hasFocusOutline () const noexcept
bool isEnabled () const noexcept
void setEnabled (bool shouldBeEnabled)
float getAlpha () const noexcept
void setAlpha (float newAlpha)
virtual void alphaChanged ()
void setMouseCursor (const MouseCursor &cursorType)
virtual MouseCursor getMouseCursor ()
void updateMouseCursor () const
void mouseMove (const MouseEvent &event) override
void mouseEnter (const MouseEvent &event) override
void mouseExit (const MouseEvent &event) override
void mouseDown (const MouseEvent &event) override
void mouseDrag (const MouseEvent &event) override
void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
void mouseMagnify (const MouseEvent &event, float scaleFactor) override
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
void removeMouseListener (MouseListener *listenerToRemove)
void addKeyListener (KeyListener *newListener)
void removeKeyListener (KeyListener *listenerToRemove)
virtual bool keyPressed (const KeyPress &key)
virtual bool keyStateChanged (bool isKeyDown)
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
virtual void focusLost (FocusChangeType cause)
virtual void focusOfChildComponentChanged (FocusChangeType cause)
bool isMouseOver (bool includeChildren=false) const
bool isMouseButtonDown (bool includeChildren=false) const
bool isMouseOverOrDragging (bool includeChildren=false) const
Point< intgetMouseXYRelative () const
virtual void moved ()
virtual void childBoundsChanged (Component *child)
virtual void parentSizeChanged ()
virtual void broughtToFront ()
void addComponentListener (ComponentListener *newListener)
void removeComponentListener (ComponentListener *listenerToRemove)
void postCommandMessage (int commandId)
virtual void handleCommandMessage (int commandId)
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
void exitModalState (int returnValue)
bool isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
bool isCurrentlyBlockedByAnotherModalComponent () const
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
NamedValueSetgetProperties () noexcept
const NamedValueSetgetProperties () const noexcept
Colour findColour (int colourID, bool inheritFromParent=false) const
void setColour (int colourID, Colour newColour)
void removeColour (int colourID)
bool isColourSpecified (int colourID) const
void copyAllExplicitColoursTo (Component &target) const
voidgetWindowHandle () const
PositionergetPositioner () const noexcept
void setPositioner (Positioner *newPositioner)
void setCachedComponentImage (CachedComponentImage *newCachedImage)
CachedComponentImagegetCachedComponentImage () const noexcept
void setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
bool getViewportIgnoreDragFlag () const noexcept
String getTitle () const noexcept
void setTitle (const String &newTitle)
String getDescription () const noexcept
void setDescription (const String &newDescription)
String getHelpText () const noexcept
void setHelpText (const String &newHelpText)
void setAccessible (bool shouldBeAccessible)
bool isAccessible () const noexcept
AccessibilityHandlergetAccessibilityHandler ()
void invalidateAccessibilityHandler ()
void setFocusContainer (bool shouldBeFocusContainer) noexcept
void contains (int, int)=delete
Public Member Functions inherited from juce::MouseListener
virtual ~MouseListener ()=default
Public Member Functions inherited from juce::SettableTooltipClient
 ~SettableTooltipClient () override=default
virtual void setTooltip (const String &newTooltip)
String getTooltip () override
Public Member Functions inherited from juce::TooltipClient
virtual ~TooltipClient ()=default
Public Member Functions inherited from juce::FileDragAndDropTarget
virtual ~FileDragAndDropTarget ()=default
virtual void fileDragEnter (const StringArray &files, int x, int y)
virtual void fileDragMove (const StringArray &files, int x, int y)
virtual void fileDragExit (const StringArray &files)

Private Attributes

TextPropertyComponentowner
int maxChars
bool isMultiline
bool interestedInFileDrag = true
String textToDisplayWhenEmpty
float alphaToUseForEmptyText = 0.0f

Additional Inherited Members

Public Types inherited from juce::Label
enum  ColourIds {
  backgroundColourId = 0x1000280 , textColourId = 0x1000281 , outlineColourId = 0x1000282 , backgroundWhenEditingColourId = 0x1000283 ,
  textWhenEditingColourId = 0x1000284 , outlineWhenEditingColourId = 0x1000285
}
Public Types inherited from juce::Component
enum class  FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum  FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
Static Public Member Functions inherited from juce::Component
static float JUCE_CALLTYPE getApproximateScaleFactorForComponent (const Component *targetComponent)
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
static void JUCE_CALLTYPE unfocusAllComponents ()
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
Public Attributes inherited from juce::Label
std::function< void()> onTextChange
std::function< void()> onEditorShow
std::function< void()> onEditorHide
Protected Member Functions inherited from juce::Label
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< ComponentTraversercreateKeyboardFocusTraverser () 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 juce::Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Protected Member Functions inherited from juce::SettableTooltipClient
 SettableTooltipClient ()=default
Protected Member Functions inherited from juce::TextEditor::Listener
virtual ~Listener ()=default
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandlercreateIgnoredAccessibilityHandler (Component &)

Constructor & Destructor Documentation

◆ LabelComp()

juce::TextPropertyComponent::LabelComp::LabelComp ( TextPropertyComponent & tpc,
int charLimit,
bool multiline,
bool editable )
inline

Member Function Documentation

◆ createEditorComponent()

TextEditor * juce::TextPropertyComponent::LabelComp::createEditorComponent ( )
inlineoverridevirtual

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.

Reimplemented from juce::Label.

◆ filesDropped()

void juce::TextPropertyComponent::LabelComp::filesDropped ( const StringArray & files,
int x,
int y )
inlineoverridevirtual

Callback to indicate that the user has dropped the files onto this component.

When the user drops the files, this get called, and you can use the files in whatever way is appropriate.

Note that after this is called, the fileDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.

Parameters
filesthe set of (absolute) pathnames of the files that the user is dragging
xthe mouse x position, relative to this component
ythe mouse y position, relative to this component

Implements juce::FileDragAndDropTarget.

◆ isInterestedInFileDrag()

bool juce::TextPropertyComponent::LabelComp::isInterestedInFileDrag ( const StringArray & files)
inlineoverridevirtual

Callback to check whether this target is interested in the set of files being offered.

Note that this will be called repeatedly when the user is dragging the mouse around over your component, so don't do anything time-consuming in here, like opening the files to have a look inside them!

Parameters
filesthe set of (absolute) pathnames of the files that the user is dragging
Returns
true if this component wants to receive the other callbacks regarding this type of object; if it returns false, no other callbacks will be made.

Implements juce::FileDragAndDropTarget.

◆ paintOverChildren()

void juce::TextPropertyComponent::LabelComp::paintOverChildren ( Graphics & g)
inlineoverridevirtual

Components can override this method to draw over the top of their children.

For most drawing operations, it's better to use the normal paint() method, but if you need to overlay something on top of the children, this can be used.

See also
paint, Graphics

Reimplemented from juce::Component.

◆ setInterestedInFileDrag()

void juce::TextPropertyComponent::LabelComp::setInterestedInFileDrag ( bool isInterested)
inline

◆ setTextToDisplayWhenEmpty()

void juce::TextPropertyComponent::LabelComp::setTextToDisplayWhenEmpty ( const String & text,
float alpha )
inline

◆ textWasEdited()

void juce::TextPropertyComponent::LabelComp::textWasEdited ( )
inlineoverridevirtual

Called after the user changes the text.

Reimplemented from juce::Label.

◆ updateColours()

void juce::TextPropertyComponent::LabelComp::updateColours ( )
inline

Member Data Documentation

◆ alphaToUseForEmptyText

float juce::TextPropertyComponent::LabelComp::alphaToUseForEmptyText = 0.0f
private

◆ interestedInFileDrag

bool juce::TextPropertyComponent::LabelComp::interestedInFileDrag = true
private

◆ isMultiline

bool juce::TextPropertyComponent::LabelComp::isMultiline
private

◆ maxChars

int juce::TextPropertyComponent::LabelComp::maxChars
private

◆ owner

TextPropertyComponent& juce::TextPropertyComponent::LabelComp::owner
private

◆ textToDisplayWhenEmpty

String juce::TextPropertyComponent::LabelComp::textToDisplayWhenEmpty
private

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