TextEditor Class Reference

A component containing text that can be edited. More...

Inherits Component, TextInputTarget, and SettableTooltipClient.

List of all members.

Classes
class	Listener
	Receives callbacks from a TextEditor component when it changes. 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 Member Functions
	TextEditor (const String &componentName=String::empty, juce_wchar passwordCharacter=0)
	Creates a new, empty text editor.
virtual	~TextEditor ()
	Destructor.
void	setMultiLine (bool shouldBeMultiLine, bool shouldWordWrap=true)
	Puts the editor into either multi- or single-line mode.
bool	isMultiLine () const
	Returns true if the editor is in multi-line mode.
void	setReturnKeyStartsNewLine (bool shouldStartNewLine)
	Changes the behaviour of the return key.
bool	getReturnKeyStartsNewLine () const
	Returns the value set by setReturnKeyStartsNewLine().
void	setTabKeyUsedAsCharacter (bool shouldTabKeyBeUsed)
	Indicates whether the tab key should be accepted and used to input a tab character, or whether it gets ignored.
bool	isTabKeyUsedAsCharacter () const
	Returns true if the tab key is being used for input.
void	setReadOnly (bool shouldBeReadOnly)
	Changes the editor to read-only mode.
bool	isReadOnly () const
	Returns true if the editor is in read-only mode.
void	setCaretVisible (bool shouldBeVisible)
	Makes the caret visible or invisible.
bool	isCaretVisible () const
	Returns true if the caret is enabled.
void	setScrollbarsShown (bool shouldBeEnabled)
	Enables/disables a vertical scrollbar.
bool	areScrollbarsShown () const
	Returns true if scrollbars are enabled.
void	setPasswordCharacter (juce_wchar passwordCharacter)
	Changes the password character used to disguise the text.
juce_wchar	getPasswordCharacter () const
	Returns the current password character.
void	setPopupMenuEnabled (bool menuEnabled)
	Allows a right-click menu to appear for the editor.
bool	isPopupMenuEnabled () const
	Returns true if the right-click menu is enabled.
bool	isPopupMenuCurrentlyActive () const
	Returns true if a popup-menu is currently being displayed.
void	setFont (const Font &newFont)
	Sets the font to use for newly added text.
void	applyFontToAllText (const Font &newFont)
	Applies a font to all the text in the editor.
const Font &	getFont () const
	Returns the font that's currently being used for new text.
void	setSelectAllWhenFocused (bool b)
	If set to true, focusing on the editor will highlight all its text.
void	setInputRestrictions (int maxTextLength, const String &allowedCharacters=String::empty)
	Sets limits on the characters that can be entered.
void	setTextToShowWhenEmpty (const String &text, const Colour &colourToUse)
	When the text editor is empty, it can be set to display a message.
void	setScrollBarThickness (int newThicknessPixels)
	Changes the size of the scrollbars that are used.
void	setScrollBarButtonVisibility (bool buttonsVisible)
	Shows or hides the buttons on any scrollbars that are used.
void	addListener (Listener *newListener)
	Registers a listener to be told when things happen to the text.
void	removeListener (Listener *listenerToRemove)
	Deregisters a listener.
String	getText () const
	Returns the entire contents of the editor.
const String	getTextInRange (const Range< int > &textRange) const
	Returns a section of the contents of the editor.
bool	isEmpty () const
	Returns true if there are no characters in the editor.
void	setText (const String &newText, bool sendTextChangeMessage=true)
	Sets the entire content of the editor.
Value &	getTextValue ()
	Returns a Value object that can be used to get or set the text.
void	insertTextAtCaret (const String &textToInsert)
	Inserts some text at the current caret position.
void	clear ()
	Deletes all the text from the editor.
void	cut ()
	Deletes the currently selected region.
void	copy ()
	Copies the currently selected region to the clipboard.
void	paste ()
	Pastes the contents of the clipboard into the editor at the caret position.
void	setCaretPosition (int newIndex)
	Moves the caret to be in front of a given character.
int	getCaretPosition () const
	Returns the current index of the caret.
void	scrollEditorToPositionCaret (int desiredCaretX, int desiredCaretY)
	Attempts to scroll the text editor so that the caret ends up at a specified position.
const Rectangle< int >	getCaretRectangle ()
	Get the graphical position of the caret.
void	setHighlightedRegion (const Range< int > &newSelection)
	Selects a section of the text.
const Range< int >	getHighlightedRegion () const
	Returns the range of characters that are selected.
String	getHighlightedText () const
	Returns the section of text that is currently selected.
int	getTextIndexAt (int x, int y)
	Finds the index of the character at a given position.
int	getTotalNumChars () const
	Counts the number of characters in the text.
int	getTextWidth () const
	Returns the total width of the text, as it is currently laid-out.
int	getTextHeight () const
	Returns the maximum height of the text, as it is currently laid-out.
void	setIndents (int newLeftIndent, int newTopIndent)
	Changes the size of the gap at the top and left-edge of the editor.
void	setBorder (const BorderSize< int > &border)
	Changes the size of border left around the edge of the component.
const BorderSize< int >	getBorder () const
	Returns the size of border around the edge of the component.
void	setScrollToShowCursor (bool shouldScrollToShowCaret)
	Used to disable the auto-scrolling which keeps the caret visible.
void	paint (Graphics &g)
	Components can override this method to draw their content.
void	paintOverChildren (Graphics &g)
	Components can override this method to draw over the top of their children.
void	mouseDown (const MouseEvent &e)
	Called when a mouse button is pressed while it's over this component.
void	mouseUp (const MouseEvent &e)
	Called when a mouse button is released.
void	mouseDrag (const MouseEvent &e)
	Called when the mouse is moved while a button is held down.
void	mouseDoubleClick (const MouseEvent &e)
	Called when a mouse button has been double-clicked in this component.
void	mouseWheelMove (const MouseEvent &e, float wheelIncrementX, float wheelIncrementY)
	Called when the mouse-wheel is moved.
bool	keyPressed (const KeyPress &key)
	Called when a key is pressed.
bool	keyStateChanged (bool isKeyDown)
	Called when a key is pressed or released.
void	focusGained (FocusChangeType cause)
	Called to indicate that this component has just acquired the keyboard focus.
void	focusLost (FocusChangeType cause)
	Called to indicate that this component has just lost the keyboard focus.
void	resized ()
	Called when this component's size has been changed.
void	enablementChanged ()
	Callback to indicate that this component has been enabled or disabled.
void	colourChanged ()
	This method is called when a colour is changed by the setColour() method.
void	lookAndFeelChanged ()
	Called to let the component react to a change in the look-and-feel setting.
bool	isTextInputActive () const
	Returns true if this input target is currently accepting input.
void	setTemporaryUnderlining (const Array< Range< int > > &)
	Sets a number of temporarily underlined sections.
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.
virtual void	performPopupMenuAction (int menuItemID)
	This is called to perform one of the items that was shown on the popup menu.
Protected Member Functions
void	scrollToMakeSureCursorIsVisible ()
	Scrolls the minimum distance needed to get the caret into view.
void	moveCaret (int newCaretPos)
void	moveCaretTo (int newPosition, bool isSelecting)
void	textChanged ()
	Used internally to dispatch a text-change message.
void	newTransaction ()
	Begins a new transaction in the UndoManager.
void	doUndoRedo (bool isRedo)
	Used internally to trigger an undo or redo.
virtual void	returnPressed ()
	Can be overridden to intercept return key presses directly.
virtual void	escapePressed ()
	Can be overridden to intercept escape key presses directly.
void	handleCommandMessage (int commandId)
	Called to handle a command that was sent by postCommandMessage().

---

Detailed Description

A component containing text that can be edited.

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.

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::empty,
		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).

virtual TextEditor::~TextEditor

(

)

[virtual]

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::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

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

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

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

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

Returns true if the right-click menu is enabled.

See also:

setPopupMenuEnabled

bool TextEditor::isPopupMenuCurrentlyActive

(

)

const

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

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

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

See also:

setFont

void TextEditor::setSelectAllWhenFocused

(

bool

b )

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::setInputRestrictions	(	int	maxTextLength,
		const String &	allowedCharacters = String::empty
	)

Sets limits on the characters that can be entered.

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.

void TextEditor::setTextToShowWhenEmpty	(	const String &	text,
		const 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::setScrollBarButtonVisibility

(

bool

buttonsVisible )

Shows or hides the buttons on any scrollbars that are used.

See also:

ScrollBar::setButtonVisibility

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.

const String TextEditor::getTextInRange

(

const Range< int > &

textRange )

const [virtual]

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 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:

insertText

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 )

[virtual]

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 insertTextAtCursor (String::empty).

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

void TextEditor::setCaretPosition

(

int

newIndex )

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

See also:

getCaretPosition

int TextEditor::getCaretPosition

(

)

const

Returns the current index of the caret.

See also:

setCaretPosition

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.

const Rectangle<int> TextEditor::getCaretRectangle

(

)

[virtual]

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 )

[virtual]

Selects a section of the text.

Implements TextInputTarget.

const Range<int> TextEditor::getHighlightedRegion

(

)

const [virtual]

Returns the range of characters that are selected.

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

See also:

setHighlightedRegion

Implements TextInputTarget.

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 co-ordinates 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

const 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::paint

(

Graphics &

g )

[virtual]

Components can override this method to draw their content.

The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.

Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.

If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In Juce (and almost all modern UI frameworks), you never redraw something synchronously.

You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().

Parameters:

g	the graphics context that must be used to do the drawing operations.

See also:

repaint, paintOverChildren, Graphics

Reimplemented from Component.

void TextEditor::paintOverChildren

(

Graphics &

g )

[virtual]

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 Component.

void TextEditor::mouseDown

(

const MouseEvent &

e )

[virtual]

Called when a mouse button is pressed while it's over this component.

The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.

Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.

Parameters:

e	details about the position and status of the mouse event

See also:

mouseUp, mouseDrag, mouseDoubleClick, contains

Reimplemented from Component.

void TextEditor::mouseUp

(

const MouseEvent &

e )

[virtual]

Called when a mouse button is released.

A mouseUp callback is sent to the component in which a button was pressed even if the mouse is actually over a different component when the button is released.

The MouseEvent object passed in contains lots of methods for finding out which buttons were down just before they were released.

Parameters:

e	details about the position and status of the mouse event

See also:

mouseDown, mouseDrag, mouseDoubleClick, contains

Reimplemented from Component.

void TextEditor::mouseDrag

(

const MouseEvent &

e )

[virtual]

Called when the mouse is moved while a button is held down.

When a mouse button is pressed inside a component, that component receives mouseDrag callbacks each time the mouse moves, even if the mouse strays outside the component's bounds.

If you want to be able to drag things off the edge of a component and have the component scroll when you get to the edges, the beginDragAutoRepeat() method might be useful.

Parameters:

e	details about the position and status of the mouse event

See also:

mouseDown, mouseUp, mouseMove, contains, beginDragAutoRepeat

Reimplemented from Component.

void TextEditor::mouseDoubleClick

(

const MouseEvent &

e )

[virtual]

Called when a mouse button has been double-clicked in this component.

The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.

For altering the time limit used to detect double-clicks, see MouseEvent::setDoubleClickTimeout.

Parameters:

e	details about the position and status of the mouse event

See also:

mouseDown, mouseUp, MouseEvent::setDoubleClickTimeout, MouseEvent::getDoubleClickTimeout

Reimplemented from Component.

void TextEditor::mouseWheelMove	(	const MouseEvent &	e,
		float	wheelIncrementX,
		float	wheelIncrementY
	)		[virtual]

Called when the mouse-wheel is moved.

This callback is sent to the component that the mouse is over when the wheel is moved.

If not overridden, the component will forward this message to its parent, so that parent components can collect mouse-wheel messages that happen to child components which aren't interested in them.

Parameters:

e	details about the position and status of the mouse event
wheelIncrementX	the speed and direction of the horizontal scroll-wheel - a positive value means the wheel has been pushed to the right, negative means it was pushed to the left
wheelIncrementY	the speed and direction of the vertical scroll-wheel - a positive value means the wheel has been pushed upwards, negative means it was pushed downwards

Reimplemented from Component.

bool TextEditor::keyPressed

(

const KeyPress &

key )

[virtual]

Called when a key is pressed.

When a key is pressed, the component that has the keyboard focus will have this method called. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.

If your implementation returns true, the event will be consumed and not passed on to any other listeners. If it returns false, the key will be passed to any KeyListeners that have been registered with this component. As soon as one of these returns true, the process will stop, but if they all return false, the event will be passed upwards to this component's parent, and so on.

The default implementation of this method does nothing and returns false.

See also:

keyStateChanged, getCurrentlyFocusedComponent, addKeyListener

Reimplemented from Component.

bool TextEditor::keyStateChanged

(

bool

isKeyDown )

[virtual]

Called when a key is pressed or released.

Whenever a key on the keyboard is pressed or released (including modifier keys like shift and ctrl), this method will be called on the component that currently has the keyboard focus. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.

If your implementation returns true, the event will be consumed and not passed on to any other listeners. If it returns false, then any KeyListeners that have been registered with this component will have their keyStateChanged methods called. As soon as one of these returns true, the process will stop, but if they all return false, the event will be passed upwards to this component's parent, and so on.

The default implementation of this method does nothing and returns false.

To find out which keys are up or down at any time, see the KeyPress::isKeyCurrentlyDown() method.

Parameters:

isKeyDown

true if a key has been pressed; false if it has been released

See also:

keyPressed, KeyPress, getCurrentlyFocusedComponent, addKeyListener

Reimplemented from Component.

void TextEditor::focusGained

(

FocusChangeType

cause )

[virtual]

Called to indicate that this component has just acquired the keyboard focus.

See also:

focusLost, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus

Reimplemented from Component.

void TextEditor::focusLost

(

FocusChangeType

cause )

[virtual]

Called to indicate that this component has just lost the keyboard focus.

See also:

focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus

Reimplemented from Component.

void TextEditor::resized

(

)

[virtual]

Called when this component's size has been changed.

A component can implement this method to do things such as laying out its child components when its width or height changes.

The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).

If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.

See also:

moved, setSize

Reimplemented from Component.

void TextEditor::enablementChanged

(

)

[virtual]

Callback to indicate that this component has been enabled or disabled.

This can be triggered by one of the component's parent components being enabled or disabled, as well as changes to the component itself.

The default implementation of this method does nothing; your class may wish to repaint itself or something when this happens.

See also:

setEnabled, isEnabled

Reimplemented from Component.

void TextEditor::colourChanged

(

)

[virtual]

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

See also:

setColour, findColour

Reimplemented from Component.

void TextEditor::lookAndFeelChanged

(

)

[virtual]

Called to let the component react to a change in the look-and-feel setting.

When the look-and-feel is changed for a component, this will be called in all its child components, recursively.

It can also be triggered manually by the sendLookAndFeelChange() method, in case an application uses a LookAndFeel class that might have changed internally.

See also:

sendLookAndFeelChange, getLookAndFeel

Reimplemented from Component.

bool TextEditor::isTextInputActive

(

)

const [virtual]

Returns true if this input target is currently accepting input.

For example, a text editor might return false if it's in read-only mode.

Implements TextInputTarget.

void TextEditor::setTemporaryUnderlining

(

const Array< Range< int > > &

underlinedRegions )

[virtual]

Sets a number of temporarily underlined sections.

This is needed by MS Windows input method UI.

Implements TextInputTarget.

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 in the range 0x7fff0000 - 0x7fff1000, so you should avoid those values for your own menu IDs.

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::scrollToMakeSureCursorIsVisible

(

)

[protected]

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

void TextEditor::moveCaret

(

int

newCaretPos )

[protected]

void TextEditor::moveCaretTo	(	int	newPosition,
		bool	isSelecting
	)		[protected]

void TextEditor::textChanged

(

)

[protected]

Used internally to dispatch a text-change message.

void TextEditor::newTransaction

(

)

[protected]

Begins a new transaction in the UndoManager.

void TextEditor::doUndoRedo

(

bool

isRedo )

[protected]

Used internally to trigger an undo or redo.

virtual void TextEditor::returnPressed

(

)

[protected, virtual]

Can be overridden to intercept return key presses directly.

virtual void TextEditor::escapePressed

(

)

[protected, virtual]

Can be overridden to intercept escape key presses directly.

void TextEditor::handleCommandMessage

(

int

commandId )

[protected, virtual]

Called to handle a command that was sent by postCommandMessage().

This is called by the message thread when a command message arrives, and the component can override this method to process it in any way it needs to.

See also:

postCommandMessage

Reimplemented from Component.

---

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

• juce_TextEditor.h