TextEditor Class Reference

An editable text box. More...

Inheritance diagram for TextEditor:

Classes
class	InputFilter
	Base class for input filters that can be applied to a TextEditor to restrict the text that can be entered. More...
class	LengthAndCharacterRestriction
	An input filter for a TextEditor that limits the length of text and/or the characters that it may contain. More...
class	Listener
	Receives callbacks from a TextEditor component when it changes. More...
struct	LookAndFeelMethods
	This abstract base class is implemented by LookAndFeel classes to provide TextEditor drawing functionality. More...

Public Types
enum	ColourIds {   backgroundColourId = 0x1000200, textColourId = 0x1000201, highlightColourId = 0x1000202, highlightedTextColourId = 0x1000203,   outlineColourId = 0x1000205, focusedOutlineColourId = 0x1000206, shadowColourId = 0x1000207 }
	A set of colour IDs to use to change the colour of various aspects of the editor. More...
Public Types inherited from Component
enum	FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
	Enumeration used by the focusChanged() and focusLost() methods. More...
Public Types inherited from TextInputTarget
enum	VirtualKeyboardType {   textKeyboard = 0, numericKeyboard, decimalKeyboard, urlKeyboard,   emailAddressKeyboard, phoneNumberKeyboard }
	A set of possible on-screen keyboard types, for use in the getKeyboardType() method. More...

Public Member Functions
	TextEditor (const String &componentName=String(), juce_wchar passwordCharacter=0)
	Creates a new, empty text editor. More...
	~TextEditor ()
	Destructor. More...
void	setMultiLine (bool shouldBeMultiLine, bool shouldWordWrap=true)
	Puts the editor into either multi- or single-line mode. More...
bool	isMultiLine () const
	Returns true if the editor is in multi-line mode. More...
void	setReturnKeyStartsNewLine (bool shouldStartNewLine)
	Changes the behaviour of the return key. More...
bool	getReturnKeyStartsNewLine () const
	Returns the value set by setReturnKeyStartsNewLine(). More...
void	setTabKeyUsedAsCharacter (bool shouldTabKeyBeUsed)
	Indicates whether the tab key should be accepted and used to input a tab character, or whether it gets ignored. More...
bool	isTabKeyUsedAsCharacter () const
	Returns true if the tab key is being used for input. More...
void	setEscapeAndReturnKeysConsumed (bool shouldBeConsumed) noexcept
	This can be used to change whether escape and return keypress events are propagated up to the parent component. More...
void	setReadOnly (bool shouldBeReadOnly)
	Changes the editor to read-only mode. More...
bool	isReadOnly () const noexcept
	Returns true if the editor is in read-only mode. More...
void	setCaretVisible (bool shouldBeVisible)
	Makes the caret visible or invisible. More...
bool	isCaretVisible () const noexcept
	Returns true if the caret is enabled. More...
void	setScrollbarsShown (bool shouldBeEnabled)
	Enables/disables a vertical scrollbar. More...
bool	areScrollbarsShown () const noexcept
	Returns true if scrollbars are enabled. More...
void	setPasswordCharacter (juce_wchar passwordCharacter)
	Changes the password character used to disguise the text. More...
juce_wchar	getPasswordCharacter () const noexcept
	Returns the current password character. More...
void	setPopupMenuEnabled (bool menuEnabled)
	Allows a right-click menu to appear for the editor. More...
bool	isPopupMenuEnabled () const noexcept
	Returns true if the right-click menu is enabled. More...
bool	isPopupMenuCurrentlyActive () const noexcept
	Returns true if a popup-menu is currently being displayed. More...
void	setFont (const Font &newFont)
	Sets the font to use for newly added text. More...
void	applyFontToAllText (const Font &newFont)
	Applies a font to all the text in the editor. More...
const Font &	getFont () const noexcept
	Returns the font that's currently being used for new text. More...
void	setSelectAllWhenFocused (bool shouldSelectAll)
	If set to true, focusing on the editor will highlight all its text. More...
void	setTextToShowWhenEmpty (const String &text, Colour colourToUse)
	When the text editor is empty, it can be set to display a message. More...
void	setScrollBarThickness (int newThicknessPixels)
	Changes the size of the scrollbars that are used. More...
void	addListener (Listener *newListener)
	Registers a listener to be told when things happen to the text. More...
void	removeListener (Listener *listenerToRemove)
	Deregisters a listener. More...
String	getText () const
	Returns the entire contents of the editor. More...
String	getTextInRange (const Range< int > &textRange) const override
	Returns a section of the contents of the editor. More...
bool	isEmpty () const
	Returns true if there are no characters in the editor. More...
void	setText (const String &newText, bool sendTextChangeMessage=true)
	Sets the entire content of the editor. More...
Value &	getTextValue ()
	Returns a Value object that can be used to get or set the text. More...
void	insertTextAtCaret (const String &textToInsert) override
	Inserts some text at the current caret position. More...
void	clear ()
	Deletes all the text from the editor. More...
void	cut ()
	Deletes the currently selected region. More...
void	copy ()
	Copies the currently selected region to the clipboard. More...
void	paste ()
	Pastes the contents of the clipboard into the editor at the caret position. More...
int	getCaretPosition () const
	Returns the current index of the caret. More...
void	setCaretPosition (int newIndex)
	Moves the caret to be in front of a given character. More...
void	scrollEditorToPositionCaret (int desiredCaretX, int desiredCaretY)
	Attempts to scroll the text editor so that the caret ends up at a specified position. More...
Rectangle< int >	getCaretRectangle () override
	Get the graphical position of the caret. More...
void	setHighlightedRegion (const Range< int > &newSelection) override
	Selects a section of the text. More...
Range< int >	getHighlightedRegion () const override
	Returns the range of characters that are selected. More...
String	getHighlightedText () const
	Returns the section of text that is currently selected. More...
int	getTextIndexAt (int x, int y)
	Finds the index of the character at a given position. More...
int	getTotalNumChars () const
	Counts the number of characters in the text. More...
int	getTextWidth () const
	Returns the total width of the text, as it is currently laid-out. More...
int	getTextHeight () const
	Returns the maximum height of the text, as it is currently laid-out. More...
void	setIndents (int newLeftIndent, int newTopIndent)
	Changes the size of the gap at the top and left-edge of the editor. More...
void	setBorder (const BorderSize< int > &border)
	Changes the size of border left around the edge of the component. More...
BorderSize< int >	getBorder () const
	Returns the size of border around the edge of the component. More...
void	setScrollToShowCursor (bool shouldScrollToShowCaret)
	Used to disable the auto-scrolling which keeps the caret visible. More...
void	moveCaretToEnd ()
bool	moveCaretLeft (bool moveInWholeWordSteps, bool selecting)
bool	moveCaretRight (bool moveInWholeWordSteps, bool selecting)
bool	moveCaretUp (bool selecting)
bool	moveCaretDown (bool selecting)
bool	pageUp (bool selecting)
bool	pageDown (bool selecting)
bool	scrollDown ()
bool	scrollUp ()
bool	moveCaretToTop (bool selecting)
bool	moveCaretToStartOfLine (bool selecting)
bool	moveCaretToEnd (bool selecting)
bool	moveCaretToEndOfLine (bool selecting)
bool	deleteBackwards (bool moveInWholeWordSteps)
bool	deleteForwards (bool moveInWholeWordSteps)
bool	copyToClipboard ()
bool	cutToClipboard ()
bool	pasteFromClipboard ()
bool	selectAll ()
bool	undo ()
bool	redo ()
virtual void	addPopupMenuItems (PopupMenu &menuToAddTo, const MouseEvent *mouseClickEvent)
	This adds the items to the popup menu. More...
virtual void	performPopupMenuAction (int menuItemID)
	This is called to perform one of the items that was shown on the popup menu. More...
void	setInputFilter (InputFilter *newFilter, bool takeOwnership)
	Sets an input filter that should be applied to this editor. More...
InputFilter *	getInputFilter () const noexcept
	Returns the current InputFilter, as set by setInputFilter(). More...
void	setInputRestrictions (int maxTextLength, const String &allowedCharacters=String())
	Sets limits on the characters that can be entered. More...
void	setKeyboardType (VirtualKeyboardType type) noexcept
void	paint (Graphics &) override
void	paintOverChildren (Graphics &) override
void	mouseDown (const MouseEvent &) override
void	mouseUp (const MouseEvent &) override
void	mouseDrag (const MouseEvent &) override
void	mouseDoubleClick (const MouseEvent &) override
void	mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override
bool	keyPressed (const KeyPress &) override
bool	keyStateChanged (bool) override
void	focusGained (FocusChangeType) override
void	focusLost (FocusChangeType) override
void	resized () override
void	enablementChanged () override
void	colourChanged () override
void	lookAndFeelChanged () override
bool	isTextInputActive () const override
void	setTemporaryUnderlining (const Array< Range< int > > &) override
VirtualKeyboardType	getKeyboardType () override
Public Member Functions inherited from Component
	Component () noexcept
	Creates a component. More...
virtual	~Component ()
	Destructor. More...
	Component (const String &componentName) noexcept
	Creates a component, setting its name at the same time. More...
const String &	getName () const noexcept
	Returns the name of this component. More...
virtual void	setName (const String &newName)
	Sets the name of this component. More...
const String &	getComponentID () const noexcept
	Returns the ID string that was set by setComponentID(). More...
void	setComponentID (const String &newID)
	Sets the component's ID string. More...
virtual void	setVisible (bool shouldBeVisible)
	Makes the component visible or invisible. More...
bool	isVisible () const noexcept
	Tests whether the component is visible or not. More...
virtual void	visibilityChanged ()
	Called when this component's visibility changes. More...
bool	isShowing () const
	Tests whether this component and all its parents are visible. More...
virtual void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
	Makes this component appear as a window on the desktop. More...
void	removeFromDesktop ()
	If the component is currently showing on the desktop, this will hide it. More...
bool	isOnDesktop () const noexcept
	Returns true if this component is currently showing on the desktop. More...
ComponentPeer *	getPeer () const
	Returns the heavyweight window that contains this component. More...
virtual void	userTriedToCloseWindow ()
	For components on the desktop, this is called if the system wants to close the window. More...
virtual void	minimisationStateChanged (bool isNowMinimised)
	Called for a desktop component which has just been minimised or un-minimised. More...
virtual float	getDesktopScaleFactor () const
	Returns the default scale factor to use for this component when it is placed on the desktop. More...
void	toFront (bool shouldAlsoGainFocus)
	Brings the component to the front of its siblings. More...
void	toBack ()
	Changes this component's z-order to be at the back of all its siblings. More...
void	toBehind (Component *other)
	Changes this component's z-order so that it's just behind another component. More...
void	setAlwaysOnTop (bool shouldStayOnTop)
	Sets whether the component should always be kept at the front of its siblings. More...
bool	isAlwaysOnTop () const noexcept
	Returns true if this component is set to always stay in front of its siblings. More...
int	getX () const noexcept
	Returns the x coordinate of the component's left edge. More...
int	getY () const noexcept
	Returns the y coordinate of the top of this component. More...
int	getWidth () const noexcept
	Returns the component's width in pixels. More...
int	getHeight () const noexcept
	Returns the component's height in pixels. More...
int	getRight () const noexcept
	Returns the x coordinate of the component's right-hand edge. More...
Point< int >	getPosition () const noexcept
	Returns the component's top-left position as a Point. More...
int	getBottom () const noexcept
	Returns the y coordinate of the bottom edge of this component. More...
const Rectangle< int > &	getBounds () const noexcept
	Returns this component's bounding box. More...
Rectangle< int >	getLocalBounds () const noexcept
	Returns the component's bounds, relative to its own origin. More...
Rectangle< int >	getBoundsInParent () const noexcept
	Returns the area of this component's parent which this component covers. More...
int	getScreenX () const
	Returns this component's x coordinate relative the screen's top-left origin. More...
int	getScreenY () const
	Returns this component's y coordinate relative the screen's top-left origin. More...
Point< int >	getScreenPosition () const
	Returns the position of this component's top-left corner relative to the screen's top-left. More...
Rectangle< int >	getScreenBounds () const
	Returns the bounds of this component, relative to the screen's top-left. More...
Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
	Converts a point to be relative to this component's coordinate space. More...
Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
	Converts a point to be relative to this component's coordinate space. More...
Rectangle< int >	getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
	Converts a rectangle to be relative to this component's coordinate space. More...
Point< int >	localPointToGlobal (Point< int > localPoint) const
	Converts a point relative to this component's top-left into a screen coordinate. More...
Point< float >	localPointToGlobal (Point< float > localPoint) const
	Converts a point relative to this component's top-left into a screen coordinate. More...
Rectangle< int >	localAreaToGlobal (const Rectangle< int > &localArea) const
	Converts a rectangle from this component's coordinate space to a screen coordinate. More...
void	setTopLeftPosition (int x, int y)
	Moves the component to a new position. More...
void	setTopLeftPosition (Point< int > newTopLeftPosition)
	Moves the component to a new position. More...
void	setTopRightPosition (int x, int y)
	Moves the component to a new position. More...
void	setSize (int newWidth, int newHeight)
	Changes the size of the component. More...
void	setBounds (int x, int y, int width, int height)
	Changes the component's position and size. More...
void	setBounds (const Rectangle< int > &newBounds)
	Changes the component's position and size. More...
void	setBounds (const RelativeRectangle &newBounds)
	Changes the component's position and size. More...
void	setBounds (const String &newBoundsExpression)
	Sets the component's bounds with an expression. More...
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. More...
void	setBoundsInset (const BorderSize< int > &borders)
	Changes the component's position and size based on the amount of space to leave around it. More...
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. More...
void	setCentrePosition (int x, int y)
	Changes the position of the component's centre. More...
void	setCentreRelative (float x, float y)
	Changes the position of the component's centre. More...
void	centreWithSize (int width, int height)
	Changes the component's size and centres it within its parent. More...
void	setTransform (const AffineTransform &transform)
	Sets a transform matrix to be applied to this component. More...
AffineTransform	getTransform () const
	Returns the transform that is currently being applied to this component. More...
bool	isTransformed () const noexcept
	Returns true if a non-identity transform is being applied to this component. More...
int	proportionOfWidth (float proportion) const noexcept
	Returns a proportion of the component's width. More...
int	proportionOfHeight (float proportion) const noexcept
	Returns a proportion of the component's height. More...
int	getParentWidth () const noexcept
	Returns the width of the component's parent. More...
int	getParentHeight () const noexcept
	Returns the height of the component's parent. More...
Rectangle< int >	getParentMonitorArea () const
	Returns the screen coordinates of the monitor that contains this component. More...
int	getNumChildComponents () const noexcept
	Returns the number of child components that this component contains. More...
Component *	getChildComponent (int index) const noexcept
	Returns one of this component's child components, by it index. More...
int	getIndexOfChildComponent (const Component *child) const noexcept
	Returns the index of this component in the list of child components. More...
Component *	findChildWithID (StringRef componentID) const noexcept
	Looks for a child component with the specified ID. More...
void	addChildComponent (Component *child, int zOrder=-1)
	Adds a child component to this one. More...
void	addChildComponent (Component &child, int zOrder=-1)
	Adds a child component to this one. More...
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. More...
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. More...
void	addChildAndSetID (Component *child, const String &componentID)
	Adds a child component to this one, makes it visible, and sets its component ID. More...
void	removeChildComponent (Component *childToRemove)
	Removes one of this component's child-components. More...
Component *	removeChildComponent (int childIndexToRemove)
	Removes one of this component's child-components by index. More...
void	removeAllChildren ()
	Removes all this component's children. More...
void	deleteAllChildren ()
	Removes and deletes all of this component's children. More...
Component *	getParentComponent () const noexcept
	Returns the component which this component is inside. More...
template<class TargetClass >
TargetClass *	findParentComponentOfClass () const
	Searches the parent components for a component of a specified class. More...
Component *	getTopLevelComponent () const noexcept
	Returns the highest-level component which contains this one or its parents. More...
bool	isParentOf (const Component *possibleChild) const noexcept
	Checks whether a component is anywhere inside this component or its children. More...
virtual void	parentHierarchyChanged ()
	Called to indicate that the component's parents have changed. More...
virtual void	childrenChanged ()
	Subclasses can use this callback to be told when children are added or removed, or when their z-order changes. More...
virtual bool	hitTest (int x, int y)
	Tests whether a given point is inside the component. More...
void	setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
	Changes the default return value for the hitTest() method. More...
void	getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
	Retrieves the current state of the mouse-click interception flags. More...
bool	contains (Point< int > localPoint)
	Returns true if a given point lies within this component or one of its children. More...
bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
	Returns true if a given point lies in this component, taking any overlapping siblings into account. More...
Component *	getComponentAt (int x, int y)
	Returns the component at a certain point within this one. More...
Component *	getComponentAt (Point< int > position)
	Returns the component at a certain point within this one. More...
void	repaint ()
	Marks the whole component as needing to be redrawn. More...
void	repaint (int x, int y, int width, int height)
	Marks a subsection of this component as needing to be redrawn. More...
void	repaint (const Rectangle< int > &area)
	Marks a subsection of this component as needing to be redrawn. More...
void	setBufferedToImage (bool shouldBeBuffered)
	Makes the component use an internal buffer to optimise its redrawing. More...
Image	createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
	Generates a snapshot of part of this component. More...
void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
	Draws this component and all its subcomponents onto the specified graphics context. More...
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. More...
void	setComponentEffect (ImageEffectFilter *newEffect)
	Adds an effect filter to alter the component's appearance. More...
ImageEffectFilter *	getComponentEffect () const noexcept
	Returns the current component effect. More...
LookAndFeel &	getLookAndFeel () const noexcept
	Finds the appropriate look-and-feel to use for this component. More...
void	setLookAndFeel (LookAndFeel *newLookAndFeel)
	Sets the look and feel to use for this component. More...
void	sendLookAndFeelChange ()
	Calls the lookAndFeelChanged() method in this component and all its children. More...
void	setOpaque (bool shouldBeOpaque)
	Indicates whether any parts of the component might be transparent. More...
bool	isOpaque () const noexcept
	Returns true if no parts of this component are transparent. More...
void	setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
	Indicates whether the component should be brought to the front when clicked. More...
bool	isBroughtToFrontOnMouseClick () const noexcept
	Indicates whether the component should be brought to the front when clicked-on. More...
void	setWantsKeyboardFocus (bool wantsFocus) noexcept
	Sets a flag to indicate whether this component needs keyboard focus or not. More...
bool	getWantsKeyboardFocus () const noexcept
	Returns true if the component is interested in getting keyboard focus. More...
void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
	Chooses whether a click on this component automatically grabs the focus. More...
bool	getMouseClickGrabsKeyboardFocus () const noexcept
	Returns the last value set with setMouseClickGrabsKeyboardFocus(). More...
void	grabKeyboardFocus ()
	Tries to give keyboard focus to this component. More...
bool	hasKeyboardFocus (bool trueIfChildIsFocused) const
	Returns true if this component currently has the keyboard focus. More...
void	moveKeyboardFocusToSibling (bool moveToNext)
	Tries to move the keyboard focus to one of this component's siblings. More...
virtual KeyboardFocusTraverser *	createFocusTraverser ()
	Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component. More...
int	getExplicitFocusOrder () const
	Returns the focus order of this component, if one has been specified. More...
void	setExplicitFocusOrder (int newFocusOrderIndex)
	Sets the index used in determining the order in which focusable components should be traversed. More...
void	setFocusContainer (bool shouldBeFocusContainer) noexcept
	Indicates whether this component is a parent for components that can have their focus traversed. More...
bool	isFocusContainer () const noexcept
	Returns true if this component has been marked as a focus container. More...
bool	isEnabled () const noexcept
	Returns true if the component (and all its parents) are enabled. More...
void	setEnabled (bool shouldBeEnabled)
	Enables or disables this component. More...
float	getAlpha () const noexcept
	Returns the component's current transparancy level. More...
void	setAlpha (float newAlpha)
	Changes the transparency of this component. More...
virtual void	alphaChanged ()
	Called when setAlpha() is used to change the alpha value of this component. More...
void	setMouseCursor (const MouseCursor &cursorType)
	Changes the mouse cursor shape to use when the mouse is over this component. More...
virtual MouseCursor	getMouseCursor ()
	Returns the mouse cursor shape to use when the mouse is over this component. More...
void	updateMouseCursor () const
	Forces the current mouse cursor to be updated. More...
virtual void	mouseMove (const MouseEvent &event) override
	Called when the mouse moves inside a component. More...
virtual void	mouseEnter (const MouseEvent &event) override
	Called when the mouse first enters a component. More...
virtual void	mouseExit (const MouseEvent &event) override
	Called when the mouse moves out of a component. More...
virtual void	mouseMagnify (const MouseEvent &event, float scaleFactor)
	Called when a pinch-to-zoom mouse-gesture is used. More...
void	setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
	Causes automatic repaints when the mouse enters or exits this component. More...
void	addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
	Registers a listener to be told when mouse events occur in this component. More...
void	removeMouseListener (MouseListener *listenerToRemove)
	Deregisters a mouse listener. More...
void	addKeyListener (KeyListener *newListener)
	Adds a listener that wants to hear about keypresses that this component receives. More...
void	removeKeyListener (KeyListener *listenerToRemove)
	Removes a previously-registered key listener. More...
virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
	Called when a modifier key is pressed or released. More...
virtual void	focusOfChildComponentChanged (FocusChangeType cause)
	Called to indicate a change in whether or not this component is the parent of the currently-focused component. More...
bool	isMouseOver (bool includeChildren=false) const
	Returns true if the mouse is currently over this component. More...
bool	isMouseButtonDown () const
	Returns true if the mouse button is currently held down in this component. More...
bool	isMouseOverOrDragging (bool includeChildren=false) const
	True if the mouse is over this component, or if it's being dragged in this component. More...
Point< int >	getMouseXYRelative () const
	Returns the mouse's current position, relative to this component. More...
virtual void	moved ()
	Called when this component's position has been changed. More...
virtual void	childBoundsChanged (Component *child)
	Called when one of this component's children is moved or resized. More...
virtual void	parentSizeChanged ()
	Called when this component's immediate parent has been resized. More...
virtual void	broughtToFront ()
	Called when this component has been moved to the front of its siblings. More...
void	addComponentListener (ComponentListener *newListener)
	Adds a listener to be told about changes to the component hierarchy or position. More...
void	removeComponentListener (ComponentListener *listenerToRemove)
	Removes a component listener. More...
void	postCommandMessage (int commandId)
	Dispatches a numbered message to this component. More...
int	runModalLoop ()
	Runs a component modally, waiting until the loop terminates. More...
void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
	Puts the component into a modal state. More...
void	exitModalState (int returnValue)
	Ends a component's modal state. More...
bool	isCurrentlyModal () const noexcept
	Returns true if this component is the modal one. More...
bool	isCurrentlyBlockedByAnotherModalComponent () const
	Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More...
virtual bool	canModalEventBeSentToComponent (const Component *targetComponent)
	When a component is modal, this callback allows it to choose which other components can still receive events. More...
virtual void	inputAttemptWhenModal ()
	Called when the user tries to click on a component that is blocked by another modal component. More...
NamedValueSet &	getProperties () noexcept
	Returns the set of properties that belong to this component. More...
const NamedValueSet &	getProperties () const noexcept
	Returns the set of properties that belong to this component. More...
Colour	findColour (int colourId, bool inheritFromParent=false) const
	Looks for a colour that has been registered with the given colour ID number. More...
void	setColour (int colourId, Colour newColour)
	Registers a colour to be used for a particular purpose. More...
void	removeColour (int colourId)
	If a colour has been set with setColour(), this will remove it. More...
bool	isColourSpecified (int colourId) const
	Returns true if the specified colour ID has been explicitly set for this component using the setColour() method. More...
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. More...
virtual MarkerList *	getMarkers (bool xAxis)
	Components can implement this method to provide a MarkerList. More...
void *	getWindowHandle () const
	Returns the underlying native window handle for this component. More...
Positioner *	getPositioner () const noexcept
	Returns the Positioner object that has been set for this component. More...
void	setPositioner (Positioner *newPositioner)
	Sets a new Positioner object for this component. More...
void	setCachedComponentImage (CachedComponentImage *newCachedImage)
	Gives the component a CachedComponentImage that should be used to buffer its painting. More...
CachedComponentImage *	getCachedComponentImage () const noexcept
	Returns the object that was set by setCachedComponentImage(). More...
	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. More...
Public Member Functions inherited from TextInputTarget
	TextInputTarget ()
virtual	~TextInputTarget ()
	Destructor. More...
Public Member Functions inherited from SettableTooltipClient
	~SettableTooltipClient ()
	Destructor. More...
virtual void	setTooltip (const String &newTooltip)
	Assigns a new tooltip to this object. More...
String	getTooltip () override
	Returns the tooltip assigned to this object. More...
Public Member Functions inherited from TooltipClient
virtual	~TooltipClient ()
	Destructor. More...

Protected Member Functions
void	scrollToMakeSureCursorIsVisible ()
	Scrolls the minimum distance needed to get the caret into view. More...
void	textChanged ()
	Used internally to dispatch a text-change message. More...
void	newTransaction ()
	Begins a new transaction in the UndoManager. More...
virtual void	returnPressed ()
	Can be overridden to intercept return key presses directly. More...
virtual void	escapePressed ()
	Can be overridden to intercept escape key presses directly. More...
Protected Member Functions inherited from SettableTooltipClient
	SettableTooltipClient ()

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. More...
static void JUCE_CALLTYPE	unfocusAllComponents ()
	If any component has keyboard focus, this will defocus it. More...
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. More...
static bool JUCE_CALLTYPE	isMouseButtonDownAnywhere () noexcept
	Returns true if a mouse button is currently down. More...
static int JUCE_CALLTYPE	getNumCurrentlyModalComponents () noexcept
	Returns the number of components that are currently in a modal state. More...
static Component *JUCE_CALLTYPE	getCurrentlyModalComponent (int index=0) noexcept
	Returns one of the components that are currently modal. More...

Detailed Description

An editable text box.

A TextEditor can either be in single- or multi-line mode, and supports mixed fonts and colours.

See also

TextEditor::Listener, Label

Member Enumeration Documentation

enum TextEditor::ColourIds

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

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

NB: You can also set the caret colour using CaretComponent::caretColourId

See also

Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour

Enumerator
backgroundColourId	The colour to use for the text component's background - this can be transparent if necessary.
textColourId	The colour that will be used when text is added to the editor. Note that because the editor can contain multiple colours, calling this method won't change the colour of existing text - to do that, call applyFontToAllText() after calling this method.
highlightColourId	The colour with which to fill the background of highlighted sections of the text - this can be transparent if you don't want to show any highlighting.
highlightedTextColourId	The colour with which to draw the text in highlighted sections.
outlineColourId	If this is non-transparent, it will be used to draw a box around the edge of the component.
focusedOutlineColourId	If this is non-transparent, it will be used to draw a box around the edge of the component when it has focus.
shadowColourId	If this is non-transparent, it'll be used to draw an inner shadow around the edge of the editor.

Constructor & Destructor Documentation

TextEditor::TextEditor ( const String &  componentName = String(), juce_wchar  passwordCharacter = 0  )

explicit

Creates a new, empty text editor.

Parameters

componentName	the name to pass to the component for it to use as its name
passwordCharacter	if this is not zero, this character will be used as a replacement for all characters that are drawn on screen - e.g. to create a password-style textbox containing circular blobs instead of text, you could set this value to 0x25cf, which is the unicode character for a black splodge (not all fonts include this, though), or 0x2022, which is a bullet (probably the best choice for linux).

TextEditor::~TextEditor

(

)

Destructor.

Member Function Documentation

void TextEditor::setMultiLine	(	bool	shouldBeMultiLine,
		bool	shouldWordWrap = true
	)

Puts the editor into either multi- or single-line mode.

By default, the editor will be in single-line mode, so use this if you need a multi-line editor.

See also the setReturnKeyStartsNewLine() method, which will also need to be turned on if you want a multi-line editor with line-breaks.

See also

isMultiLine, setReturnKeyStartsNewLine

bool TextEditor::isMultiLine

(

)

const

Returns true if the editor is in multi-line mode.

void TextEditor::setReturnKeyStartsNewLine

(

bool

shouldStartNewLine

)

Changes the behaviour of the return key.

If set to true, the return key will insert a new-line into the text; if false it will trigger a call to the TextEditor::Listener::textEditorReturnKeyPressed() method. By default this is set to false, and when true it will only insert new-lines when in multi-line mode (see setMultiLine()).

bool TextEditor::getReturnKeyStartsNewLine

(

)

const

Returns the value set by setReturnKeyStartsNewLine().

See setReturnKeyStartsNewLine() for more info.

void TextEditor::setTabKeyUsedAsCharacter

(

bool

shouldTabKeyBeUsed

)

Indicates whether the tab key should be accepted and used to input a tab character, or whether it gets ignored.

By default the tab key is ignored, so that it can be used to switch keyboard focus between components.

bool TextEditor::isTabKeyUsedAsCharacter

(

)

const

Returns true if the tab key is being used for input.

See also

setTabKeyUsedAsCharacter

void TextEditor::setEscapeAndReturnKeysConsumed ( bool  shouldBeConsumed )

noexcept

This can be used to change whether escape and return keypress events are propagated up to the parent component.

The default here is true, meaning that these events are not allowed to reach the parent, but you may want to allow them through so that they can trigger other actions, e.g. closing a dialog box, etc.

void TextEditor::setReadOnly

(

bool

shouldBeReadOnly

)

Changes the editor to read-only mode.

By default, the text editor is not read-only. If you're making it read-only, you might also want to call setCaretVisible (false) to get rid of the caret.

The text can still be highlighted and copied when in read-only mode.

See also

isReadOnly, setCaretVisible

bool TextEditor::isReadOnly ( ) const

noexcept

Returns true if the editor is in read-only mode.

void TextEditor::setCaretVisible

(

bool

shouldBeVisible

)

Makes the caret visible or invisible.

By default the caret is visible.

See also

setCaretColour, setCaretPosition

bool TextEditor::isCaretVisible ( ) const

noexcept

Returns true if the caret is enabled.

See also

setCaretVisible

void TextEditor::setScrollbarsShown

(

bool

shouldBeEnabled

)

Enables/disables a vertical scrollbar.

(This only applies when in multi-line mode). When the text gets too long to fit in the component, a scrollbar can appear to allow it to be scrolled. Even when this is enabled, the scrollbar will be hidden unless it's needed.

By default the scrollbar is enabled.

bool TextEditor::areScrollbarsShown ( ) const

noexcept

Returns true if scrollbars are enabled.

See also

setScrollbarsShown

void TextEditor::setPasswordCharacter

(

juce_wchar

passwordCharacter

)

Changes the password character used to disguise the text.

Parameters

passwordCharacter

if this is not zero, this character will be used as a replacement for all characters that are drawn on screen - e.g. to create a password-style textbox containing circular blobs instead of text, you could set this value to 0x25cf, which is the unicode character for a black splodge (not all fonts include this, though), or 0x2022, which is a bullet (probably the best choice for linux).

juce_wchar TextEditor::getPasswordCharacter ( ) const

noexcept

Returns the current password character.

See also

setPasswordCharacter

void TextEditor::setPopupMenuEnabled

(

bool

menuEnabled

)

Allows a right-click menu to appear for the editor.

(This defaults to being enabled).

If enabled, right-clicking (or command-clicking on the Mac) will pop up a menu of options such as cut/copy/paste, undo/redo, etc.

bool TextEditor::isPopupMenuEnabled ( ) const

noexcept

Returns true if the right-click menu is enabled.

See also

setPopupMenuEnabled

bool TextEditor::isPopupMenuCurrentlyActive ( ) const

noexcept

Returns true if a popup-menu is currently being displayed.

void TextEditor::setFont

(

const Font &

newFont

)

Sets the font to use for newly added text.

This will change the font that will be used next time any text is added or entered into the editor. It won't change the font of any existing text - to do that, use applyFontToAllText() instead.

See also

applyFontToAllText

Referenced by Label::getTextValue().

void TextEditor::applyFontToAllText

(

const Font &

newFont

)

Applies a font to all the text in the editor.

This will also set the current font to use for any new text that's added.

See also

setFont

const Font& TextEditor::getFont ( ) const

noexcept

Returns the font that's currently being used for new text.

See also

setFont

Referenced by Label::getTextValue().

void TextEditor::setSelectAllWhenFocused

(

bool

shouldSelectAll

)

If set to true, focusing on the editor will highlight all its text.

(Set to false by default).

This is useful for boxes where you expect the user to re-enter all the text when they focus on the component, rather than editing what's already there.

void TextEditor::setTextToShowWhenEmpty	(	const String &	text,
		Colour	colourToUse
	)

When the text editor is empty, it can be set to display a message.

This is handy for things like telling the user what to type in the box - the string is only displayed, it's not taken to actually be the contents of the editor.

void TextEditor::setScrollBarThickness

(

int

newThicknessPixels

)

Changes the size of the scrollbars that are used.

Handy if you need smaller scrollbars for a small text box.

void TextEditor::addListener

(

Listener *

newListener

)

Registers a listener to be told when things happen to the text.

See also

removeListener

void TextEditor::removeListener

(

Listener *

listenerToRemove

)

Deregisters a listener.

See also

addListener

String TextEditor::getText

(

)

const

Returns the entire contents of the editor.

String TextEditor::getTextInRange ( const Range< int > &  textRange ) const

overridevirtual

Returns a section of the contents of the editor.

Implements TextInputTarget.

bool TextEditor::isEmpty

(

)

const

Returns true if there are no characters in the editor.

This is far more efficient than calling getText().isEmpty().

void TextEditor::setText	(	const String &	newText,
		bool	sendTextChangeMessage = true
	)

Sets the entire content of the editor.

This will clear the editor and insert the given text (using the current text colour and font). You can set the current text colour using

setColour (TextEditor::textColourId, ...);

Parameters

newText	the text to add
sendTextChangeMessage	if true, this will cause a change message to be sent to all the listeners.

See also

insertTextAtCaret

Value& TextEditor::getTextValue

(

)

Returns a Value object that can be used to get or set the text.

Bear in mind that this operate quite slowly if your text box contains large amounts of text, as it needs to dynamically build the string that's involved. It's best used for small text boxes.

void TextEditor::insertTextAtCaret ( const String &  textToInsert )

overridevirtual

Inserts some text at the current caret position.

If a section of the text is highlighted, it will be replaced by this string, otherwise it will be inserted.

To delete a section of text, you can use setHighlightedRegion() to highlight it, and call insertTextAtCaret (String()).

See also

setCaretPosition, getCaretPosition, setHighlightedRegion

Implements TextInputTarget.

void TextEditor::clear

(

)

Deletes all the text from the editor.

void TextEditor::cut

(

)

Deletes the currently selected region.

This doesn't copy the deleted section to the clipboard - if you need to do that, call copy() first.

See also

copy, paste, SystemClipboard

void TextEditor::copy

(

)

Copies the currently selected region to the clipboard.

See also

cut, paste, SystemClipboard

void TextEditor::paste

(

)

Pastes the contents of the clipboard into the editor at the caret position.

See also

cut, copy, SystemClipboard

int TextEditor::getCaretPosition

(

)

const

Returns the current index of the caret.

See also

setCaretPosition

void TextEditor::setCaretPosition

(

int

newIndex

)

Moves the caret to be in front of a given character.

See also

getCaretPosition, moveCaretToEnd

void TextEditor::scrollEditorToPositionCaret	(	int	desiredCaretX,
		int	desiredCaretY
	)

Attempts to scroll the text editor so that the caret ends up at a specified position.

This won't affect the caret's position within the text, it tries to scroll the entire editor vertically and horizontally so that the caret is sitting at the given position (relative to the top-left of this component).

Depending on the amount of text available, it might not be possible to scroll far enough for the caret to reach this exact position, but it will go as far as it can in that direction.

Rectangle<int> TextEditor::getCaretRectangle ( )

overridevirtual

Get the graphical position of the caret.

The rectangle returned is relative to the component's top-left corner.

See also

scrollEditorToPositionCaret

Implements TextInputTarget.

void TextEditor::setHighlightedRegion ( const Range< int > &  newSelection )

overridevirtual

Selects a section of the text.

Implements TextInputTarget.

Range<int> TextEditor::getHighlightedRegion ( ) const

overridevirtual

Returns the range of characters that are selected.

If nothing is selected, this will return an empty range.

See also

setHighlightedRegion

Implements TextInputTarget.

References StandardApplicationCommandIDs::redo, StandardApplicationCommandIDs::selectAll, and StandardApplicationCommandIDs::undo.

String TextEditor::getHighlightedText

(

)

const

Returns the section of text that is currently selected.

int TextEditor::getTextIndexAt	(	int	x,
		int	y
	)

Finds the index of the character at a given position.

The coordinates are relative to the component's top-left.

int TextEditor::getTotalNumChars

(

)

const

Counts the number of characters in the text.

This is quicker than getting the text as a string if you just need to know the length.

int TextEditor::getTextWidth

(

)

const

Returns the total width of the text, as it is currently laid-out.

This may be larger than the size of the TextEditor, and can change when the TextEditor is resized or the text changes.

int TextEditor::getTextHeight

(

)

const

Returns the maximum height of the text, as it is currently laid-out.

This may be larger than the size of the TextEditor, and can change when the TextEditor is resized or the text changes.

void TextEditor::setIndents	(	int	newLeftIndent,
		int	newTopIndent
	)

Changes the size of the gap at the top and left-edge of the editor.

By default there's a gap of 4 pixels.

void TextEditor::setBorder

(

const BorderSize< int > &

border

)

Changes the size of border left around the edge of the component.

See also

getBorder

BorderSize<int> TextEditor::getBorder

(

)

const

Returns the size of border around the edge of the component.

See also

setBorder

void TextEditor::setScrollToShowCursor

(

bool

shouldScrollToShowCaret

)

Used to disable the auto-scrolling which keeps the caret visible.

If true (the default), the editor will scroll when the caret moves offscreen. If set to false, it won't.

void TextEditor::moveCaretToEnd

(

)

bool TextEditor::moveCaretLeft	(	bool	moveInWholeWordSteps,
		bool	selecting
	)

bool TextEditor::moveCaretRight	(	bool	moveInWholeWordSteps,
		bool	selecting
	)

bool TextEditor::moveCaretUp

(

bool

selecting

)

bool TextEditor::moveCaretDown

(

bool

selecting

)

bool TextEditor::pageUp

(

bool

selecting

)

bool TextEditor::pageDown

(

bool

selecting

)

bool TextEditor::scrollDown

(

)

bool TextEditor::scrollUp

(

)

bool TextEditor::moveCaretToTop

(

bool

selecting

)

bool TextEditor::moveCaretToStartOfLine

(

bool

selecting

)

bool TextEditor::moveCaretToEnd

(

bool

selecting

)

bool TextEditor::moveCaretToEndOfLine

(

bool

selecting

)

bool TextEditor::deleteBackwards

(

bool

moveInWholeWordSteps

)

bool TextEditor::deleteForwards

(

bool

moveInWholeWordSteps

)

bool TextEditor::copyToClipboard

(

)

bool TextEditor::cutToClipboard

(

)

bool TextEditor::pasteFromClipboard

(

)

bool TextEditor::selectAll

(

)

bool TextEditor::undo

(

)

bool TextEditor::redo

(

)

virtual void TextEditor::addPopupMenuItems ( PopupMenu &  menuToAddTo, const MouseEvent *  mouseClickEvent  )

virtual

This adds the items to the popup menu.

By default it adds the cut/copy/paste items, but you can override this if you need to replace these with your own items.

If you want to add your own items to the existing ones, you can override this, call the base class's addPopupMenuItems() method, then append your own items.

When the menu has been shown, performPopupMenuAction() will be called to perform the item that the user has chosen.

The default menu items will be added using item IDs from the StandardApplicationCommandIDs namespace.

If this was triggered by a mouse-click, the mouseClickEvent parameter will be a pointer to the info about it, or may be null if the menu is being triggered by some other means.

See also

performPopupMenuAction, setPopupMenuEnabled, isPopupMenuEnabled

virtual void TextEditor::performPopupMenuAction ( int  menuItemID )

virtual

This is called to perform one of the items that was shown on the popup menu.

If you've overridden addPopupMenuItems(), you should also override this to perform the actions that you've added.

If you've overridden addPopupMenuItems() but have still left the default items on the menu, remember to call the superclass's performPopupMenuAction() so that it can perform the default actions if that's what the user clicked on.

See also

addPopupMenuItems, setPopupMenuEnabled, isPopupMenuEnabled

void TextEditor::setInputFilter	(	InputFilter *	newFilter,
		bool	takeOwnership
	)

Sets an input filter that should be applied to this editor.

The filter can be nullptr, to remove any existing filters. If takeOwnership is true, then the filter will be owned and deleted by the editor when no longer needed.

InputFilter* TextEditor::getInputFilter ( ) const

noexcept

Returns the current InputFilter, as set by setInputFilter().

References setInputRestrictions().

void TextEditor::setInputRestrictions	(	int	maxTextLength,
		const String &	allowedCharacters = String()
	)

Sets limits on the characters that can be entered.

This is just a shortcut that passes an instance of the LengthAndCharacterRestriction class to setInputFilter().

Parameters

maxTextLength	if this is > 0, it sets a maximum length limit; if 0, no limit is set
allowedCharacters	if this is non-empty, then only characters that occur in this string are allowed to be entered into the editor.

Referenced by getInputFilter().

void TextEditor::setKeyboardType ( VirtualKeyboardType  type )

noexcept

void TextEditor::paint ( Graphics &  )

overridevirtual

Reimplemented from Component.

void TextEditor::paintOverChildren ( Graphics &  )

overridevirtual

Reimplemented from Component.

void TextEditor::mouseDown ( const MouseEvent &  )

overridevirtual

Reimplemented from Component.

void TextEditor::mouseUp ( const MouseEvent &  )

overridevirtual

Reimplemented from Component.

void TextEditor::mouseDrag ( const MouseEvent &  )

overridevirtual

Reimplemented from Component.

void TextEditor::mouseDoubleClick ( const MouseEvent &  )

overridevirtual

Reimplemented from Component.

void TextEditor::mouseWheelMove ( const MouseEvent &  , const MouseWheelDetails &    )

overridevirtual

Reimplemented from Component.

bool TextEditor::keyPressed ( const KeyPress &  )

overridevirtual

Reimplemented from Component.

bool TextEditor::keyStateChanged ( bool  )

overridevirtual

Reimplemented from Component.

void TextEditor::focusGained ( FocusChangeType  )

overridevirtual

Reimplemented from Component.

void TextEditor::focusLost ( FocusChangeType  )

overridevirtual

Reimplemented from Component.

void TextEditor::resized ( )

overridevirtual

Reimplemented from Component.

void TextEditor::enablementChanged ( )

overridevirtual

Reimplemented from Component.

void TextEditor::colourChanged ( )

overridevirtual

Reimplemented from Component.

void TextEditor::lookAndFeelChanged ( )

overridevirtual

Reimplemented from Component.

bool TextEditor::isTextInputActive ( ) const

overridevirtual

Implements TextInputTarget.

void TextEditor::setTemporaryUnderlining ( const Array< Range< int > > &  )

overridevirtual

Implements TextInputTarget.

VirtualKeyboardType TextEditor::getKeyboardType ( )

overridevirtual

Reimplemented from TextInputTarget.

References JUCE_PUBLIC_IN_DLL_BUILD.

void TextEditor::scrollToMakeSureCursorIsVisible ( )

protected

Scrolls the minimum distance needed to get the caret into view.

void TextEditor::textChanged ( )

protected

Used internally to dispatch a text-change message.

void TextEditor::newTransaction ( )

protected

Begins a new transaction in the UndoManager.

virtual void TextEditor::returnPressed ( )

protectedvirtual

Can be overridden to intercept return key presses directly.

virtual void TextEditor::escapePressed ( )

protectedvirtual

Can be overridden to intercept escape key presses directly.

---

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

• juce_TextEditor.h