openshot-audio  0.1.7
Classes | Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
TextEditor Class Reference

#include <juce_TextEditor.h>

Inheritance diagram for TextEditor:
SettableTooltipClient TooltipClient AlertTextComp

Classes

class  InputFilter
 
class  InsertAction
 
class  Iterator
 
class  LengthAndCharacterRestriction
 
class  Listener
 
struct  LookAndFeelMethods
 
class  RemoveAction
 
class  TextHolderComponent
 
class  UniformTextSection
 

Public Types

enum  ColourIds {
  backgroundColourId = 0x1000200, textColourId = 0x1000201, highlightColourId = 0x1000202, highlightedTextColourId = 0x1000203,
  outlineColourId = 0x1000205, focusedOutlineColourId = 0x1000206, shadowColourId = 0x1000207
}
 

Public Member Functions

 TextEditor (const String &componentName=String::empty, juce_wchar passwordCharacter=0)
 
 ~TextEditor ()
 
void setMultiLine (bool shouldBeMultiLine, bool shouldWordWrap=true)
 
bool isMultiLine () const
 
void setReturnKeyStartsNewLine (bool shouldStartNewLine)
 
bool getReturnKeyStartsNewLine () const
 
void setTabKeyUsedAsCharacter (bool shouldTabKeyBeUsed)
 
bool isTabKeyUsedAsCharacter () const
 
void setEscapeAndReturnKeysConsumed (bool shouldBeConsumed) noexcept
 
void setReadOnly (bool shouldBeReadOnly)
 
bool isReadOnly () const
 
void setCaretVisible (bool shouldBeVisible)
 
bool isCaretVisible () const noexcept
 
void setScrollbarsShown (bool shouldBeEnabled)
 
bool areScrollbarsShown () const noexcept
 
void setPasswordCharacter (juce_wchar passwordCharacter)
 
juce_wchar getPasswordCharacter () const noexcept
 
void setPopupMenuEnabled (bool menuEnabled)
 
bool isPopupMenuEnabled () const noexcept
 
bool isPopupMenuCurrentlyActive () const noexcept
 
void setFont (const Font &newFont)
 
void applyFontToAllText (const Font &newFont)
 
const FontgetFont () const noexcept
 
void setSelectAllWhenFocused (bool shouldSelectAll)
 
void setTextToShowWhenEmpty (const String &text, Colour colourToUse)
 
void setScrollBarThickness (int newThicknessPixels)
 
void addListener (Listener *newListener)
 
void removeListener (Listener *listenerToRemove)
 
String getText () const
 
String getTextInRange (const Range< int > &textRange) const override
 
bool isEmpty () const
 
void setText (const String &newText, bool sendTextChangeMessage=true)
 
ValuegetTextValue ()
 
void insertTextAtCaret (const String &textToInsert) override
 
void clear ()
 
void cut ()
 
void copy ()
 
void paste ()
 
int getCaretPosition () const
 
void setCaretPosition (int newIndex)
 
void scrollEditorToPositionCaret (int desiredCaretX, int desiredCaretY)
 
Rectangle< intgetCaretRectangle () override
 
void setHighlightedRegion (const Range< int > &newSelection) override
 
Range< intgetHighlightedRegion () const override
 
String getHighlightedText () const
 
int getTextIndexAt (int x, int y)
 
int getTotalNumChars () const
 
int getTextWidth () const
 
int getTextHeight () const
 
void setIndents (int newLeftIndent, int newTopIndent)
 
void setBorder (const BorderSize< int > &border)
 
BorderSize< intgetBorder () const
 
void setScrollToShowCursor (bool shouldScrollToShowCaret)
 
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)
 
virtual void performPopupMenuAction (int menuItemID)
 
void setInputFilter (InputFilter *newFilter, bool takeOwnership)
 
InputFiltergetInputFilter () const noexcept
 
void setInputRestrictions (int maxTextLength, const String &allowedCharacters=String::empty)
 
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 SettableTooltipClient
virtual ~SettableTooltipClient ()
 
virtual void setTooltip (const String &newTooltip)
 
virtual String getTooltip ()
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 

Protected Member Functions

void scrollToMakeSureCursorIsVisible ()
 
void textChanged ()
 
void newTransaction ()
 
virtual void returnPressed ()
 
virtual void escapePressed ()
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 

Friends

class InsertAction
 
class RemoveAction
 
class TextHolderComponent
 
class TextEditorViewport
 

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

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::empty,
juce_wchar  passwordCharacter = 0 
)
explicit

Creates a new, empty text editor.

Parameters
componentNamethe name to pass to the component for it to use as its name
passwordCharacterif 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::addListener ( Listener newListener)

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

See Also
removeListener
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
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
bool TextEditor::areScrollbarsShown ( ) const
inlinenoexcept

Returns true if scrollbars are enabled.

See Also
setScrollbarsShown
void TextEditor::clear ( )

Deletes all the text from the editor.

void TextEditor::colourChanged ( )
override
void TextEditor::copy ( )

Copies the currently selected region to the clipboard.

See Also
cut, paste, SystemClipboard
bool TextEditor::copyToClipboard ( )
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
bool TextEditor::cutToClipboard ( )
bool TextEditor::deleteBackwards ( bool  moveInWholeWordSteps)
bool TextEditor::deleteForwards ( bool  moveInWholeWordSteps)
void TextEditor::enablementChanged ( )
override
void TextEditor::escapePressed ( )
protectedvirtual

Can be overridden to intercept escape key presses directly

void TextEditor::focusGained ( FocusChangeType  )
override
void TextEditor::focusLost ( FocusChangeType  )
override
BorderSize< int > TextEditor::getBorder ( ) const

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

See Also
setBorder
int TextEditor::getCaretPosition ( ) const

Returns the current index of the caret.

See Also
setCaretPosition
Rectangle< int > TextEditor::getCaretRectangle ( )
override

Get the graphical position of the caret.

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

See Also
scrollEditorToPositionCaret
const Font& TextEditor::getFont ( ) const
inlinenoexcept

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

See Also
setFont
Range<int> TextEditor::getHighlightedRegion ( ) const
inlineoverride

Returns the range of characters that are selected. If nothing is selected, this will return an empty range.

See Also
setHighlightedRegion
String TextEditor::getHighlightedText ( ) const

Returns the section of text that is currently selected.

InputFilter* TextEditor::getInputFilter ( ) const
inlinenoexcept

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

VirtualKeyboardType TextEditor::getKeyboardType ( )
inlineoverride
juce_wchar TextEditor::getPasswordCharacter ( ) const
inlinenoexcept

Returns the current password character.

See Also
setPasswordCharacter
bool TextEditor::getReturnKeyStartsNewLine ( ) const
inline

Returns the value set by setReturnKeyStartsNewLine(). See setReturnKeyStartsNewLine() for more info.

String TextEditor::getText ( ) const

Returns the entire contents of the editor.

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.

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.

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

Returns a section of the contents of the editor.

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.

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

void TextEditor::insertTextAtCaret ( const String textToInsert)
override

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
bool TextEditor::isCaretVisible ( ) const
inlinenoexcept

Returns true if the caret is enabled.

See Also
setCaretVisible
bool TextEditor::isEmpty ( ) const

Returns true if there are no characters in the editor. This is far more efficient than calling getText().isEmpty().

bool TextEditor::isMultiLine ( ) const

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

bool TextEditor::isPopupMenuCurrentlyActive ( ) const
inlinenoexcept

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

bool TextEditor::isPopupMenuEnabled ( ) const
inlinenoexcept

Returns true if the right-click menu is enabled.

See Also
setPopupMenuEnabled
bool TextEditor::isReadOnly ( ) const

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

bool TextEditor::isTabKeyUsedAsCharacter ( ) const
inline

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

See Also
setTabKeyUsedAsCharacter
bool TextEditor::isTextInputActive ( ) const
override
bool TextEditor::keyPressed ( const KeyPress key)
override
bool TextEditor::keyStateChanged ( bool  isKeyDown)
override
void TextEditor::lookAndFeelChanged ( )
override
void TextEditor::mouseDoubleClick ( const MouseEvent e)
override
void TextEditor::mouseDown ( const MouseEvent e)
override
void TextEditor::mouseDrag ( const MouseEvent e)
override
void TextEditor::mouseUp ( const MouseEvent e)
override
void TextEditor::mouseWheelMove ( const MouseEvent e,
const MouseWheelDetails wheel 
)
override
bool TextEditor::moveCaretDown ( bool  selecting)
bool TextEditor::moveCaretLeft ( bool  moveInWholeWordSteps,
bool  selecting 
)
bool TextEditor::moveCaretRight ( bool  moveInWholeWordSteps,
bool  selecting 
)
void TextEditor::moveCaretToEnd ( )
bool TextEditor::moveCaretToEnd ( bool  selecting)
bool TextEditor::moveCaretToEndOfLine ( bool  selecting)
bool TextEditor::moveCaretToStartOfLine ( bool  selecting)
bool TextEditor::moveCaretToTop ( bool  selecting)
bool TextEditor::moveCaretUp ( bool  selecting)
void TextEditor::newTransaction ( )
protected

Begins a new transaction in the UndoManager.

bool TextEditor::pageDown ( bool  selecting)
bool TextEditor::pageUp ( bool  selecting)
void TextEditor::paint ( Graphics g)
override
void TextEditor::paintOverChildren ( Graphics g)
override
void TextEditor::paste ( )

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

See Also
cut, copy, SystemClipboard
bool TextEditor::pasteFromClipboard ( )
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
bool TextEditor::redo ( )
void TextEditor::removeListener ( Listener listenerToRemove)

Deregisters a listener.

See Also
addListener
void TextEditor::resized ( )
override
void TextEditor::returnPressed ( )
protectedvirtual

Can be overridden to intercept return key presses directly

bool TextEditor::scrollDown ( )
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.

void TextEditor::scrollToMakeSureCursorIsVisible ( )
protected

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

bool TextEditor::scrollUp ( )
bool TextEditor::selectAll ( )
void TextEditor::setBorder ( const BorderSize< int > &  border)

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

See Also
getBorder
void TextEditor::setCaretPosition ( int  newIndex)

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

See Also
getCaretPosition, moveCaretToEnd
void TextEditor::setCaretVisible ( bool  shouldBeVisible)

Makes the caret visible or invisible. By default the caret is visible.

See Also
setCaretColour, setCaretPosition
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::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::setHighlightedRegion ( const Range< int > &  newSelection)
override

Selects a section of the text.

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

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

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
maxTextLengthif this is > 0, it sets a maximum length limit; if 0, no limit is set
allowedCharactersif this is non-empty, then only characters that occur in this string are allowed to be entered into the editor.
void TextEditor::setKeyboardType ( VirtualKeyboardType  type)
inlinenoexcept
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
void TextEditor::setPasswordCharacter ( juce_wchar  passwordCharacter)

Changes the password character used to disguise the text.

Parameters
passwordCharacterif 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).
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.

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
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()).

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.

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

void TextEditor::setTemporaryUnderlining ( const Array< Range< int > > &  newUnderlinedSections)
override
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
newTextthe text to add
sendTextChangeMessageif true, this will cause a change message to be sent to all the listeners.
See Also
insertText
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::textChanged ( )
protected

Used internally to dispatch a text-change message.

bool TextEditor::undo ( )

Friends And Related Function Documentation

friend class InsertAction
friend
friend class RemoveAction
friend
friend class TextEditorViewport
friend
friend class TextHolderComponent
friend

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