From d5dcaee4c5b41faca64f02888b152f7f05c4a20b Mon Sep 17 00:00:00 2001 From: Paulb23 Date: Thu, 8 Jul 2021 18:35:56 +0100 Subject: Cleanup and rename caret operations --- doc/classes/TextEdit.xml | 142 ++++++++++++++++++++++++++++------------------- 1 file changed, 86 insertions(+), 56 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 855f19852f..00e15f9f2a 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -56,8 +56,9 @@ Called when the user presses the backspace key. Can be overriden with [method _backspace]. - - + + + Centers the viewport on the line the editing cursor is at. This also resets the [member scroll_horizontal] value to [code]0[/code]. @@ -80,60 +81,52 @@ Copy's the current text selection. Can be overriden with [method _copy]. - - - - Returns the column the editing cursor is at. - - - - + + + - Returns the line the editing cursor is at. + Cut's the current selection. Can be overriden with [method _cut]. - - - - + + + - Moves the cursor at the specified [code]column[/code] index. - If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the cursor position after the move occurs. - - - - - - + + + - Moves the cursor at the specified [code]line[/code] index. - If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the cursor position after the move occurs. - If [code]can_be_hidden[/code] is set to [code]true[/code], the specified [code]line[/code] can be hidden. + Deselects the current selection. - - + + + - Cut's the current selection. Can be overriden with [method _cut]. + Returns the column the editing caret is at. - - + + + + Gets the caret pixel draw poistion. - - + + + - Deselects the current selection. + Returns the line the editing caret is on. - - + + + - Gets the caret pixel draw position. + Returns the wrap index the editing caret is on. @@ -295,17 +288,20 @@ Returns the number of visible lines, including wrapped text. - - + + + - Returns a [String] text with the word under the caret (text cursor) location. + Returns a [String] text with the word under the caret location. - - - + + + + + - Insert the specified text at the cursor position. + Insert the specified text at the caret position. @@ -435,6 +431,35 @@ If [member selecting_enabled] is [code]false[/code], no selection will occur. + + + + + + + + + Moves the caret to the specified [code]column[/code] index. + If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the caret position after the move occurs. + + + + + + + + + + + + + + + Moves the caret to the specified [code]line[/code] index. + If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the caret position after the move occurs. + If [code]can_be_hidden[/code] is set to [code]true[/code], the specified [code]line[/code] can be hidden. + + @@ -572,24 +597,23 @@ - - If [code]true[/code], the caret (visual cursor) blinks. + + Sets if the caret should blink. - + Duration (in seconds) of a caret's blinking cycle. - - If [code]true[/code], the caret displays as a rectangle. - If [code]false[/code], the caret displays as a bar. - - + Allow moving caret, selecting and removing the individual composite character components. Note: [kbd]Backspace[/kbd] is always removing individual composite character components. - - If [code]true[/code], a right-click moves the cursor at the mouse position before displaying the context menu. + + If [code]true[/code], a right-click moves the caret at the mouse position before displaying the context menu. If [code]false[/code], the context menu disregards mouse location. + + Set the type of caret to draw. + If [code]true[/code], a right-click displays the context menu. @@ -667,9 +691,9 @@ - + - Emitted when the cursor changes. + Emitted when the caret changes position. @@ -708,6 +732,12 @@ Search from end to beginning. + + Vertical line caret. + + + Block caret. + -- cgit v1.2.3