#include <juce_TextPropertyComponent.h>

Inheritance diagram for juce::TextPropertyComponent:

Classes
class	Listener
class	LabelComp

Public Types
enum	ColourIds { backgroundColourId = 0x100e401 , textColourId = 0x100e402 , outlineColourId = 0x100e403 }
Public Types inherited from juce::PropertyComponent
enum	ColourIds { backgroundColourId = 0x1008300 , labelTextColourId = 0x1008301 }
Public Types inherited from juce::Component
enum class	FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum	FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }

Public Member Functions
	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
void	colourChanged () override
void	addListener (Listener *newListener)
void	removeListener (Listener *listener)
void	setInterestedInFileDrag (bool isInterested)
void	setEditable (bool isEditable)
void	refresh () override
virtual void	textWasEdited ()
Public Member Functions inherited from juce::PropertyComponent
	PropertyComponent (const String &propertyName, int preferredHeight=25)
	~PropertyComponent () override
int	getPreferredHeight () const noexcept
void	setPreferredHeight (int newHeight) noexcept
void	paint (Graphics &) override
void	resized () override
void	enablementChanged () override
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
ComponentPeer *	getPeer () 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< int >	getPosition () const noexcept
int	getBottom () const noexcept
Rectangle< int >	getBounds () const noexcept
Rectangle< int >	getLocalBounds () const noexcept
Rectangle< int >	getBoundsInParent () const noexcept
int	getScreenX () const
int	getScreenY () const
Point< int >	getScreenPosition () const
Rectangle< int >	getScreenBounds () const
Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
Rectangle< int >	getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
Rectangle< float >	getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
Point< int >	localPointToGlobal (Point< int > localPoint) const
Point< float >	localPointToGlobal (Point< float > localPoint) const
Rectangle< int >	localAreaToGlobal (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< int >	getParentMonitorArea () const
int	getNumChildComponents () const noexcept
Component *	getChildComponent (int index) const noexcept
int	getIndexOfChildComponent (const Component *child) const noexcept
const Array< Component * > &	getChildren () const noexcept
Component *	findChildWithID (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)
Component *	removeChildComponent (int childIndexToRemove)
void	removeAllChildren ()
void	deleteAllChildren ()
Component *	getParentComponent () const noexcept
template<class TargetClass>
TargetClass *	findParentComponentOfClass () const
Component *	getTopLevelComponent () 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)
Component *	getComponentAt (int x, int y)
Component *	getComponentAt (Point< int > position)
Component *	getComponentAt (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)
ImageEffectFilter *	getComponentEffect () const noexcept
LookAndFeel &	getLookAndFeel () 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
Component *	findFocusContainer () const
Component *	findKeyboardFocusContainer () 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< ComponentTraverser >	createFocusTraverser ()
virtual std::unique_ptr< ComponentTraverser >	createKeyboardFocusTraverser ()
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
virtual void	paintOverChildren (Graphics &g)
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	mouseUp (const MouseEvent &event) override
void	mouseDoubleClick (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	focusGained (FocusChangeType cause)
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< int >	getMouseXYRelative () 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)
virtual void	inputAttemptWhenModal ()
NamedValueSet &	getProperties () noexcept
const NamedValueSet &	getProperties () 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
void *	getWindowHandle () const
Positioner *	getPositioner () const noexcept
void	setPositioner (Positioner *newPositioner)
void	setCachedComponentImage (CachedComponentImage *newCachedImage)
CachedComponentImage *	getCachedComponentImage () 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
AccessibilityHandler *	getAccessibilityHandler ()
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

Protected Member Functions
	TextPropertyComponent (const String &propertyName, int maxNumChars, bool isMultiLine, bool isEditable=true)
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Protected Member Functions inherited from juce::SettableTooltipClient
	SettableTooltipClient ()=default

Private Member Functions
void	callListeners ()
void	createEditor (int maxNumChars, bool isEditable)

Private Attributes
const bool	isMultiLine
ValueTreePropertyWithDefault	value
std::unique_ptr< LabelComp >	textEditor
ListenerList< Listener >	listenerList

Additional Inherited Members
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
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)
Protected Attributes inherited from juce::PropertyComponent
int	preferredHeight

Detailed Description

A PropertyComponent that shows its value as editable text.

See also: PropertyComponent

@tags{GUI}

Member Enumeration Documentation

◆ ColourIds

enum juce::TextPropertyComponent::ColourIds

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

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

See also: Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour

Enumerator
backgroundColourId	The colour to fill the background of the text area.
textColourId	The colour to use for the editable text.
outlineColourId	The colour to use to draw an outline around the text area.

Constructor & Destructor Documentation

◆ TextPropertyComponent() [1/3]

juce::TextPropertyComponent::TextPropertyComponent	(	const String &	propertyName,
		int	maxNumChars,
		bool	isMultiLine,
		bool	isEditable = true )

protected

Creates a text property component.

Parameters

propertyName	The name of the property
maxNumChars	If not zero, then this specifies the maximum allowable length of the string. If zero, then the string will have no length limit.
isMultiLine	Sets whether the text editor allows carriage returns.
isEditable	Sets whether the text editor is editable. The default is true.

See also: TextEditor, setEditable

◆ TextPropertyComponent() [2/3]

juce::TextPropertyComponent::TextPropertyComponent	(	const Value &	valueToControl,
		const String &	propertyName,
		int	maxNumChars,
		bool	isMultiLine,
		bool	isEditable = true )

Creates a text property component.

Parameters

valueToControl	The Value that is controlled by the TextPropertyComponent
propertyName	The name of the property
maxNumChars	If not zero, then this specifies the maximum allowable length of the string. If zero, then the string will have no length limit.
isMultiLine	Sets whether the text editor allows carriage returns.
isEditable	Sets whether the text editor is editable. The default is true.

See also: TextEditor, setEditable

◆ TextPropertyComponent() [3/3]

juce::TextPropertyComponent::TextPropertyComponent	(	const ValueTreePropertyWithDefault &	valueToControl,
		const String &	propertyName,
		int	maxNumChars,
		bool	isMultiLine,
		bool	isEditable = true )

Creates a text property component with a default value.

Parameters

valueToControl	The ValueTreePropertyWithDefault that is controlled by the TextPropertyComponent.
propertyName	The name of the property
maxNumChars	If not zero, then this specifies the maximum allowable length of the string. If zero, then the string will have no length limit.
isMultiLine	Sets whether the text editor allows carriage returns.
isEditable	Sets whether the text editor is editable. The default is true.

See also: TextEditor, setEditable

◆ ~TextPropertyComponent()

juce::TextPropertyComponent::~TextPropertyComponent ( )

override

Member Function Documentation

◆ addListener()

void juce::TextPropertyComponent::addListener ( TextPropertyComponent::Listener * l )

Registers a listener to receive events when this button's state changes. If the listener is already registered, this will not register it again.

See also: removeListener

◆ callListeners()

void juce::TextPropertyComponent::callListeners ( )

private

◆ colourChanged()

void juce::TextPropertyComponent::colourChanged ( )

overridevirtual

This method is called when a colour is changed by the setColour() method.

See also: setColour, findColour

Reimplemented from juce::Component.

◆ createEditor()

void juce::TextPropertyComponent::createEditor	(	int	maxNumChars,
		bool	isEditable )

private

◆ getText()

String juce::TextPropertyComponent::getText ( ) const

virtual

Returns the text that should be shown in the text editor.

◆ getValue()

Value & juce::TextPropertyComponent::getValue ( ) const

Returns the text that should be shown in the text editor as a Value object.

◆ isTextEditorMultiLine()

bool juce::TextPropertyComponent::isTextEditorMultiLine ( ) const

inlinenoexcept

Returns true if the text editor allows carriage returns.

◆ refresh()

void juce::TextPropertyComponent::refresh ( )

overridevirtual

Updates the property component if the item it refers to has changed.

A subclass must implement this method, and other objects may call it to force it to refresh itself.

The subclass should be economical in the amount of work is done, so for example it should check whether it really needs to do a repaint rather than just doing one every time this method is called, as it may be called when the value being displayed hasn't actually changed.

Implements juce::PropertyComponent.

◆ removeListener()

void juce::TextPropertyComponent::removeListener ( TextPropertyComponent::Listener * l )

Removes a previously-registered button listener

See also: addListener

◆ setEditable()

void juce::TextPropertyComponent::setEditable ( bool isEditable )

Sets whether the text editor is editable. The default setting for this is true.

◆ setInterestedInFileDrag()

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

Sets whether the text property component can have files dropped onto it by an external application.

The default setting for this is true but you may want to disable this behaviour if you derive from this class and want your subclass to respond to the file drag.

◆ setText()

void juce::TextPropertyComponent::setText ( const String & newText )

virtual

Called when the user edits the text.

Your subclass must use this callback to change the value of whatever item this property component represents.

◆ textWasEdited()

void juce::TextPropertyComponent::textWasEdited ( )

virtual

Member Data Documentation

◆ isMultiLine

const bool juce::TextPropertyComponent::isMultiLine

private

◆ listenerList

ListenerList<Listener> juce::TextPropertyComponent::listenerList

private

◆ textEditor

std::unique_ptr<LabelComp> juce::TextPropertyComponent::textEditor

private

◆ value

ValueTreePropertyWithDefault juce::TextPropertyComponent::value

private

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/properties/juce_TextPropertyComponent.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/properties/juce_TextPropertyComponent.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColourIds

Constructor & Destructor Documentation

◆ TextPropertyComponent() [1/3]

◆ TextPropertyComponent() [2/3]

◆ TextPropertyComponent() [3/3]

◆ ~TextPropertyComponent()

Member Function Documentation

◆ addListener()

◆ callListeners()

◆ colourChanged()

◆ createEditor()

◆ getText()

◆ getValue()

◆ isTextEditorMultiLine()

◆ refresh()

◆ removeListener()

◆ setEditable()

◆ setInterestedInFileDrag()

◆ setText()

◆ textWasEdited()

Member Data Documentation

◆ isMultiLine

◆ listenerList

◆ textEditor

◆ value