#include <juce_TextEditor.h>
Classes | |
| class | Listener |
| class | InputFilter |
| class | LengthAndCharacterRestriction |
| struct | LookAndFeelMethods |
| class | UniformTextSection |
| struct | Iterator |
| struct | InsertAction |
| struct | RemoveAction |
| struct | TextHolderComponent |
| struct | TextEditorViewport |
| class | EditorAccessibilityHandler |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1000200 , textColourId = 0x1000201 , highlightColourId = 0x1000202 , highlightedTextColourId = 0x1000203 , outlineColourId = 0x1000205 , focusedOutlineColourId = 0x1000206 , shadowColourId = 0x1000207 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
| Public Types inherited from juce::TextInputTarget | |
| enum | VirtualKeyboardType { textKeyboard = 0 , numericKeyboard , decimalKeyboard , urlKeyboard , emailAddressKeyboard , phoneNumberKeyboard } |
Public Attributes | |
| std::function< void()> | onTextChange |
| std::function< void()> | onReturnKey |
| std::function< void()> | onEscapeKey |
| std::function< void()> | onFocusLost |
Protected Member Functions | |
| void | scrollToMakeSureCursorIsVisible () |
| void | textChanged () |
| void | newTransaction () |
| virtual void | returnPressed () |
| virtual void | escapePressed () |
| Protected Member Functions inherited from juce::Component | |
| virtual ComponentPeer * | createNewPeer (int styleFlags, void *nativeWindowToAttachTo) |
| Protected Member Functions inherited from juce::SettableTooltipClient | |
| SettableTooltipClient ()=default | |
Private Types | |
| enum | DragType { notDragging , draggingSelectionStart , draggingSelectionEnd } |
Additional Inherited Members | |
| Static Public Member Functions inherited from juce::Component | |
| static float JUCE_CALLTYPE | getApproximateScaleFactorForComponent (const Component *targetComponent) |
| static Component *JUCE_CALLTYPE | getCurrentlyFocusedComponent () noexcept |
| static void JUCE_CALLTYPE | unfocusAllComponents () |
| static void JUCE_CALLTYPE | beginDragAutoRepeat (int millisecondsBetweenCallbacks) |
| static bool JUCE_CALLTYPE | isMouseButtonDownAnywhere () noexcept |
| static int JUCE_CALLTYPE | getNumCurrentlyModalComponents () noexcept |
| static Component *JUCE_CALLTYPE | getCurrentlyModalComponent (int index=0) noexcept |
| Static Protected Member Functions inherited from juce::Component | |
| static std::unique_ptr< AccessibilityHandler > | createIgnoredAccessibilityHandler (Component &) |
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
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::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
◆ DragType
|
private |
Constructor & Destructor Documentation
◆ TextEditor()
|
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()
|
override |
Destructor.
Member Function Documentation
◆ addListener()
Registers a listener to be told when things happen to the text.
- See also
- removeListener
◆ addPopupMenuItems()
|
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
◆ applyColourToAllText()
| void juce::TextEditor::applyColourToAllText | ( | const Colour & | newColour, |
| bool | changeCurrentTextColour = true ) |
Applies a colour to all the text in the editor.
If the changeCurrentTextColour argument is true then this will also set the new colour as the colour to be used for any new text that's added.
◆ applyFontToAllText()
Applies a font to all the text in the editor.
If the changeCurrentFont argument is true then this will also set the new font as the font to be used for any new text that's added.
- See also
- setFont
◆ areScrollbarsShown()
|
inlinenoexcept |
Returns true if scrollbars are enabled.
- See also
- setScrollbarsShown
◆ checkFocus()
|
private |
◆ checkLayout()
|
private |
◆ clear()
| void juce::TextEditor::clear | ( | ) |
Deletes all the text from the editor.
◆ clearInternal()
|
private |
◆ coalesceSimilarSections()
|
private |
◆ copy()
| void juce::TextEditor::copy | ( | ) |
Copies the currently selected region to the clipboard.
- See also
- cut, paste, SystemClipboard
◆ copyToClipboard()
| bool juce::TextEditor::copyToClipboard | ( | ) |
◆ createAccessibilityHandler()
|
overrideprivatevirtual |
Override this method to return a custom AccessibilityHandler for this component.
The default implementation creates and returns a AccessibilityHandler object with an unspecified role, meaning that it will be visible to accessibility clients but without a specific role, action callbacks or interfaces. To control how accessibility clients see and interact with your component subclass AccessibilityHandler, implement the desired behaviours, and return an instance of it from this method in your component subclass.
The accessibility handler you return here is guaranteed to be destroyed before its Component, so it's safe to store and use a reference back to the Component inside the AccessibilityHandler if necessary.
- See also
- getAccessibilityHandler
Reimplemented from juce::Component.
◆ cut()
| void juce::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
◆ cutToClipboard()
| bool juce::TextEditor::cutToClipboard | ( | ) |
◆ deleteBackwards()
| bool juce::TextEditor::deleteBackwards | ( | bool | moveInWholeWordSteps | ) |
◆ deleteForwards()
| bool juce::TextEditor::deleteForwards | ( | bool | moveInWholeWordSteps | ) |
◆ drawContent()
◆ enablementChanged()
|
overridevirtual |
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 juce::Component.
◆ escapePressed()
|
protectedvirtual |
Can be overridden to intercept escape key presses directly
◆ findWordBreakAfter()
◆ findWordBreakBefore()
◆ focusGained()
|
overridevirtual |
Called to indicate that this component has just acquired the keyboard focus.
- See also
- focusLost, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
Reimplemented from juce::Component.
◆ focusLost()
|
overridevirtual |
Called to indicate that this component has just lost the keyboard focus.
- See also
- focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
Reimplemented from juce::Component.
◆ getBorder()
| BorderSize< int > juce::TextEditor::getBorder | ( | ) | const |
Returns the size of border around the edge of the component.
- See also
- setBorder
◆ getCaretPosition()
| int juce::TextEditor::getCaretPosition | ( | ) | const |
Returns the current index of the caret.
- See also
- setCaretPosition
◆ getCaretRectangle()
Get the graphical position of the caret.
The rectangle returned is relative to the component's top-left corner.
- See also
- scrollEditorToPositionCaret
Implements juce::TextInputTarget.
◆ getCaretRectangleFloat()
|
private |
◆ getCharPosition()
|
private |
◆ getClicksOutsideDismissVirtualKeyboard()
|
inline |
Returns true if the editor is configured to hide the virtual keyboard when the mouse is pressed on another component.
◆ getFont()
Returns the font that's currently being used for new text.
- See also
- setFont
◆ getHighlightedRegion()
Returns the range of characters that are selected. If nothing is selected, this will return an empty range.
- See also
- setHighlightedRegion
Implements juce::TextInputTarget.
◆ getHighlightedText()
| String juce::TextEditor::getHighlightedText | ( | ) | const |
Returns the section of text that is currently selected.
◆ getInputFilter()
|
inlinenoexcept |
Returns the current InputFilter, as set by setInputFilter().
◆ getJustificationType()
|
inlinenoexcept |
Returns the type of justification, as set in setJustification().
◆ getKeyboardType()
|
inlineoverridevirtual |
Returns the target's preference for the type of keyboard that would be most appropriate. This may be ignored, depending on the capabilities of the OS.
Reimplemented from juce::TextInputTarget.
◆ getLeftIndent()
|
inlinenoexcept |
Returns the gap at the left edge of the editor.
- See also
- setIndents
◆ getLineSpacing()
|
inlinenoexcept |
Returns the current line spacing of the TextEditor.
◆ getMaximumTextHeight()
|
private |
◆ getMaximumTextWidth()
|
private |
◆ getPasswordCharacter()
|
inlinenoexcept |
Returns the current password character.
- See also
- setPasswordCharacter
◆ getReturnKeyStartsNewLine()
|
inline |
Returns the value set by setReturnKeyStartsNewLine(). See setReturnKeyStartsNewLine() for more info.
◆ getText()
| String juce::TextEditor::getText | ( | ) | const |
Returns the entire contents of the editor.
◆ getTextBounds()
| RectangleList< int > juce::TextEditor::getTextBounds | ( | Range< int > | textRange | ) |
Returns the bounding box for a range of text in the editor. As the range may span multiple lines, this method returns a RectangleList.
The bounds are relative to the component's top-left and may extend beyond the bounds of the component if the text is long and word wrapping is disabled.
◆ getTextHeight()
| int juce::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.
◆ getTextIndexAt()
Finds the index of the character at a given position. The coordinates are relative to the component's top-left.
◆ getTextInRange()
Returns a section of the contents of the editor.
Implements juce::TextInputTarget.
◆ getTextOffset()
◆ getTextToShowWhenEmpty()
|
inlinenoexcept |
Returns the text that will be shown when the text editor is empty.
- See also
- setTextToShowWhenEmpty
◆ getTextValue()
| Value & juce::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.
◆ getTextWidth()
| int juce::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.
◆ getTopIndent()
|
inlinenoexcept |
Returns the gap at the top edge of the editor.
- See also
- setIndents
◆ getTotalNumChars()
| int juce::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.
◆ getUndoManager()
|
privatenoexcept |
◆ getWordWrapWidth()
|
private |
◆ handleCommandMessage()
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 juce::Component.
◆ indexAtPosition()
|
private |
◆ insert()
|
private |
◆ insertTextAtCaret()
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 juce::TextInputTarget.
◆ isCaretVisible()
|
inlinenoexcept |
Returns true if the caret is enabled.
- See also
- setCaretVisible
◆ isEmpty()
| bool juce::TextEditor::isEmpty | ( | ) | const |
Returns true if there are no characters in the editor. This is far more efficient than calling getText().isEmpty().
◆ isMultiLine()
| bool juce::TextEditor::isMultiLine | ( | ) | const |
Returns true if the editor is in multi-line mode.
◆ isPopupMenuCurrentlyActive()
|
inlinenoexcept |
Returns true if a popup-menu is currently being displayed.
◆ isPopupMenuEnabled()
|
inlinenoexcept |
Returns true if the right-click menu is enabled.
- See also
- setPopupMenuEnabled
◆ isReadOnly()
|
noexcept |
Returns true if the editor is in read-only mode.
◆ isTabKeyUsedAsCharacter()
|
inline |
Returns true if the tab key is being used for input.
- See also
- setTabKeyUsedAsCharacter
◆ isTextInputActive()
|
overridevirtual |
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 juce::TextInputTarget.
◆ isWhitespaceUnderlined()
|
inlinenoexcept |
Returns true if whitespace is underlined for underlined fonts.
- See also
- setWhitespaceIsUnderlined
◆ keyPressed()
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 juce::Component.
◆ keyStateChanged()
|
overridevirtual |
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 juce::Component.
◆ lookAndFeelChanged()
|
overridevirtual |
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 juce::Component.
◆ mouseDoubleClick()
|
overridevirtual |
Called when a mouse button has been double-clicked on a 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.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseUp
Reimplemented from juce::Component.
◆ mouseDown()
|
overridevirtual |
Called when a mouse button is pressed.
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
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseUp, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::Component.
◆ mouseDrag()
|
overridevirtual |
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.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseUp, mouseMove, contains, setDragRepeatInterval
Reimplemented from juce::Component.
◆ mouseUp()
|
overridevirtual |
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
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::Component.
◆ mouseWheelMove()
|
overridevirtual |
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, a 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. (Bear in mind that if you attach a component as a mouse-listener to other components, then those wheel moves will also end up calling this method and being passed up to the parents, which may not be what you intended to happen).
- Parameters
-
Event details about the mouse event wheel details about the mouse wheel movement
Reimplemented from juce::Component.
◆ moveCaret()
◆ moveCaretDown()
| bool juce::TextEditor::moveCaretDown | ( | bool | selecting | ) |
◆ moveCaretLeft()
| bool juce::TextEditor::moveCaretLeft | ( | bool | moveInWholeWordSteps, |
| bool | selecting ) |
◆ moveCaretRight()
| bool juce::TextEditor::moveCaretRight | ( | bool | moveInWholeWordSteps, |
| bool | selecting ) |
◆ moveCaretTo()
◆ moveCaretToEnd() [1/2]
| void juce::TextEditor::moveCaretToEnd | ( | ) |
◆ moveCaretToEnd() [2/2]
| bool juce::TextEditor::moveCaretToEnd | ( | bool | selecting | ) |
◆ moveCaretToEndOfLine()
| bool juce::TextEditor::moveCaretToEndOfLine | ( | bool | selecting | ) |
◆ moveCaretToStartOfLine()
| bool juce::TextEditor::moveCaretToStartOfLine | ( | bool | selecting | ) |
◆ moveCaretToTop()
| bool juce::TextEditor::moveCaretToTop | ( | bool | selecting | ) |
◆ moveCaretUp()
| bool juce::TextEditor::moveCaretUp | ( | bool | selecting | ) |
◆ moveCaretWithTransaction()
|
private |
◆ newTransaction()
|
protected |
Begins a new transaction in the UndoManager.
◆ pageDown()
| bool juce::TextEditor::pageDown | ( | bool | selecting | ) |
◆ pageUp()
| bool juce::TextEditor::pageUp | ( | bool | selecting | ) |
◆ paint()
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 juce::Component.
◆ paintOverChildren()
Components can override this method to draw over the top of their children.
For most drawing operations, it's better to use the normal paint() method, but if you need to overlay something on top of the children, this can be used.
- See also
- paint, Graphics
Reimplemented from juce::Component.
◆ parentHierarchyChanged()
|
overridevirtual |
Called to indicate that the component's parents have changed.
When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).
Subclasses can override this if they need to react to this in some way.
- See also
- getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged
Reimplemented from juce::Component.
◆ paste()
| void juce::TextEditor::paste | ( | ) |
Pastes the contents of the clipboard into the editor at the caret position.
- See also
- cut, copy, SystemClipboard
◆ pasteFromClipboard()
| bool juce::TextEditor::pasteFromClipboard | ( | ) |
◆ performPopupMenuAction()
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
◆ recreateCaret()
|
private |
◆ redo()
| bool juce::TextEditor::redo | ( | ) |
◆ reinsert()
|
private |
◆ remove()
|
private |
◆ removeListener()
Deregisters a listener.
- See also
- addListener
◆ repaintText()
◆ resized()
|
overridevirtual |
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 juce::Component.
◆ returnPressed()
|
protectedvirtual |
Can be overridden to intercept return key presses directly
◆ scrollByLines()
◆ scrollDown()
| bool juce::TextEditor::scrollDown | ( | ) |
◆ scrollEditorToPositionCaret()
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.
◆ scrollToMakeSureCursorIsVisible()
|
protected |
Scrolls the minimum distance needed to get the caret into view.
◆ scrollUp()
| bool juce::TextEditor::scrollUp | ( | ) |
◆ selectAll()
| bool juce::TextEditor::selectAll | ( | ) |
◆ setBorder()
| void juce::TextEditor::setBorder | ( | BorderSize< int > | border | ) |
Changes the size of border left around the edge of the component.
- See also
- getBorder
◆ setCaretPosition()
Moves the caret to be in front of a given character.
- See also
- getCaretPosition, moveCaretToEnd
◆ setCaretVisible()
| void juce::TextEditor::setCaretVisible | ( | bool | shouldBeVisible | ) |
Makes the caret visible or invisible. By default the caret is visible.
- See also
- setCaretColour, setCaretPosition
◆ setClicksOutsideDismissVirtualKeyboard()
| void juce::TextEditor::setClicksOutsideDismissVirtualKeyboard | ( | bool | newValue | ) |
Sets the behaviour of mouse/touch interactions outside this component.
If true, then presses outside of the TextEditor will dismiss the virtual keyboard. If false, then the virtual keyboard will remain onscreen for as long as the TextEditor has keyboard focus.
◆ setEscapeAndReturnKeysConsumed()
|
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.
◆ setFont()
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
◆ setHighlightedRegion()
Selects a section of the text.
Implements juce::TextInputTarget.
◆ setIndents()
Changes the size of the gap at the top and left-edge of the editor. By default there's a gap of 4 pixels.
◆ setInputFilter()
| void juce::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.
◆ setInputRestrictions()
| void juce::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.
◆ setJustification()
| void juce::TextEditor::setJustification | ( | Justification | newJustification | ) |
Modifies the justification of the text within the editor window.
◆ setKeyboardType()
|
inlinenoexcept |
Sets the type of virtual keyboard that should be displayed when this editor has focus.
◆ setLineSpacing()
|
inlinenoexcept |
Sets the line spacing of the TextEditor. The default (and minimum) value is 1.0 and values > 1.0 will increase the line spacing as a multiple of the line height e.g. for double-spacing call this method with an argument of 2.0.
◆ setMultiLine()
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.
- Parameters
-
shouldBeMultiLine whether the editor should be multi- or single-line. shouldWordWrap sets whether long lines should be broken up in multi-line editors. If this is false and scrollbars are enabled a horizontal scrollbar will be shown.
- See also
- isMultiLine, setReturnKeyStartsNewLine, setScrollbarsShown
◆ setPasswordCharacter()
| void juce::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).
◆ setPopupMenuEnabled()
| void juce::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.
◆ setReadOnly()
| void juce::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
◆ setReturnKeyStartsNewLine()
| void juce::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()).
◆ setScrollbarsShown()
| void juce::TextEditor::setScrollbarsShown | ( | bool | shouldBeEnabled | ) |
Enables or disables scrollbars (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 scrollbars are enabled.
◆ setScrollBarThickness()
Changes the size of the scrollbars that are used. Handy if you need smaller scrollbars for a small text box.
◆ setScrollToShowCursor()
| void juce::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.
◆ setSelectAllWhenFocused()
| void juce::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.
◆ setSelection()
◆ setTabKeyUsedAsCharacter()
| void juce::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.
◆ setTemporaryUnderlining()
|
overridevirtual |
Sets a number of temporarily underlined sections. This is needed by MS Windows input method UI.
Implements juce::TextInputTarget.
◆ setText()
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
- 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
◆ setTextToShowWhenEmpty()
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.
◆ setWhitespaceUnderlined()
|
inlinenoexcept |
Sets whether whitespace should be underlined when the editor font is underlined.
- See also
- isWhitespaceUnderlined
◆ splitSection()
◆ textChanged()
|
protected |
Used internally to dispatch a text-change message.
◆ textWasChangedByValue()
|
private |
◆ timerCallbackInt()
|
private |
◆ undo()
| bool juce::TextEditor::undo | ( | ) |
◆ undoOrRedo()
|
private |
◆ updateCaretPosition()
|
private |
◆ updateValueFromText()
|
private |
Member Data Documentation
◆ borderSize
|
private |
◆ caret
|
private |
◆ caretPosition
|
private |
◆ caretVisible
|
private |
◆ clicksOutsideDismissVirtualKeyboard
|
private |
◆ colourForTextWhenEmpty
|
private |
◆ consumeEscAndReturnKeys
|
private |
◆ currentFont
|
private |
◆ dragType
|
private |
◆ inputFilter
|
private |
◆ justification
|
private |
◆ keepCaretOnScreen
|
private |
◆ keyboardType
|
private |
◆ lastTransactionTime
|
private |
◆ leftIndent
|
private |
◆ lineSpacing
|
private |
◆ listeners
|
private |
◆ menuActive
|
private |
◆ mouseDownInEditor
|
private |
◆ multiline
|
private |
◆ onEscapeKey
| std::function<void()> juce::TextEditor::onEscapeKey |
You can assign a lambda to this callback object to have it called when the escape key is pressed.
◆ onFocusLost
| std::function<void()> juce::TextEditor::onFocusLost |
You can assign a lambda to this callback object to have it called when the editor loses key focus.
◆ onReturnKey
| std::function<void()> juce::TextEditor::onReturnKey |
You can assign a lambda to this callback object to have it called when the return key is pressed.
◆ onTextChange
| std::function<void()> juce::TextEditor::onTextChange |
You can assign a lambda to this callback object to have it called when the text is changed.
◆ passwordCharacter
|
private |
◆ popupMenuEnabled
|
private |
◆ readOnly
|
private |
◆ returnKeyStartsNewLine
|
private |
◆ scrollbarVisible
|
private |
◆ sections
|
private |
◆ selectAllTextWhenFocused
|
private |
◆ selection
◆ tabKeyUsed
|
private |
◆ textHolder
|
private |
◆ textToShowWhenEmpty
|
private |
◆ textValue
|
private |
◆ topIndent
|
private |
◆ totalNumChars
|
mutableprivate |
◆ underlinedSections
◆ underlineWhitespace
|
private |
◆ undoManager
|
private |
◆ valueTextNeedsUpdating
|
private |
◆ viewport
|
private |
◆ wasFocused
|
private |
◆ wordWrap
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_TextEditor.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_TextEditor.cpp
Generated on for LMMS by
1.16.1