godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TextEdit.xml

973 lines
36 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="TextEdit" inherits="Control" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Multiline text editing control.
</brief_description>
<description>
TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo.
Scroll faster when holding Alt in TextEdit (and script editor) This feature is inspired by a similar feature found in Visual Studio Code.
2021-05-09 23:27:54 +00:00
[b]Note:[/b] When holding down [kbd]Alt[/kbd], the vertical scroll wheel will scroll 5 times as fast as it would normally do. This also works in the Godot script editor.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="_backspace" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
Make TextEdit cut, copy and paste overridable
2021-07-08 15:48:58 +00:00
Overide this method to define what happens when the user presses the backspace key.
</description>
</method>
<method name="_copy" qualifiers="virtual">
<return type="void">
</return>
<description>
Overide this method to define what happens when the user performs a copy.
</description>
</method>
<method name="_cut" qualifiers="virtual">
<return type="void">
</return>
<description>
Overide this method to define what happens when the user perfroms a cut.
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</description>
</method>
Move auto brace completion to CodeEdit
2021-06-28 16:14:44 +00:00
<method name="_handle_unicode_input" qualifiers="virtual">
Clean up and complete CodeEdit inspector and docs
2021-07-01 16:40:59 +00:00
<return type="void" />
<argument index="0" name="unicode" type="int" />
Move auto brace completion to CodeEdit
2021-06-28 16:14:44 +00:00
<description>
Make TextEdit cut, copy and paste overridable
2021-07-08 15:48:58 +00:00
Overide this method to define what happens when the types in the provided key [code]unicode[/code].
</description>
</method>
<method name="_paste" qualifiers="virtual">
<return type="void">
</return>
<description>
Overide this method to define what happens when the user perfroms a paste.
Move auto brace completion to CodeEdit
2021-06-28 16:14:44 +00:00
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="add_gutter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="at" type="int" default="-1" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="backspace">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
Make TextEdit cut, copy and paste overridable
2021-07-08 15:48:58 +00:00
Called when the user presses the backspace key. Can be overriden with [method _backspace].
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="center_viewport_to_caret">
<return type="void">
</return>
doc: Sync classref with current source
2019-06-24 08:39:59 +00:00
<description>
Add documentation for center_viewport_to_cursor method
2020-07-03 10:39:17 +00:00
Centers the viewport on the line the editing cursor is at. This also resets the [member scroll_horizontal] value to [code]0[/code].
doc: Sync classref with current source
2019-06-24 08:39:59 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="clear_opentype_features">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Removes all OpenType features.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="clear_undo_history">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Document TextEdit node
2019-06-13 09:12:52 +00:00
Clears the undo history.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="copy">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Make TextEdit cut, copy and paste overridable
2021-07-08 15:48:58 +00:00
Copy's the current text selection. Can be overriden with [method _copy].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="cut">
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Cut's the current selection. Can be overriden with [method _cut].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="delete_selection">
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="deselect">
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Deselects the current selection.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="get_caret_column" qualifiers="const">
<return type="int">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Returns the column the editing caret is at.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="get_caret_draw_pos" qualifiers="const">
<return type="Vector2">
</return>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Gets the caret pixel draw poistion.
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="get_caret_line" qualifiers="const">
<return type="int">
</return>
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Returns the line the editing caret is on.
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="get_caret_wrap_index" qualifiers="const">
<return type="int">
</return>
Update String/Comment, autocomplete and hints docs
2021-05-22 14:11:04 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Returns the wrap index the editing caret is on.
Update String/Comment, autocomplete and hints docs
2021-05-22 14:11:04 +00:00
</description>
</method>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="get_first_non_whitespace_column" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="line" type="int" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="get_gutter_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="get_gutter_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="get_gutter_type" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextEdit.GutterType" />
<argument index="0" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="get_gutter_width" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="gutter" type="int" />
Improve breakpoints and breakpoint gutter API in TextEdit Added breakpoint_gutter, is_breakpoint_gutter_enabled, set_breakpoint_gutter_enabled, get_breakpoints, remove_breakpoints. Fixed breakpoint_toggled signal not fierd when text is edited. Fixes #18026.
2018-05-30 12:02:51 +00:00
<description>
</description>
</method>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="get_indent_level" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="line" type="int" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
Add multiple descriptions to several classes This pull request adds several descriptions to multiple different classes. This improves the completeness of the documentation and enhances usability by doing so.
2021-07-06 11:22:53 +00:00
Returns the indent level of a specific line.
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_line" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="line" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the text of a specific line.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add custom background line colour to TextEdit and remove marked lines
2020-09-10 20:25:00 +00:00
<method name="get_line_background_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Color" />
<argument index="0" name="line" type="int" />
Add custom background line colour to TextEdit and remove marked lines
2020-09-10 20:25:00 +00:00
<description>
Returns the current background color of the line. [code]Color(0, 0, 0, 0)[/code] is returned if no color is set.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_line_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the amount of total lines in the text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="get_line_gutter_icon" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Texture2D" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="get_line_gutter_item_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Color" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="get_line_gutter_metadata" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Variant" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="get_line_gutter_text" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
Expose and cleanup TextEdit line wrap API
2021-07-09 10:52:49 +00:00
<method name="get_line_wrap_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
Returns the number of the time given line is wrapped.
</description>
</method>
<method name="get_line_wrap_index_at_column" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="column" type="int">
</argument>
<description>
Returns the wrap index of the given line column.
</description>
</method>
<method name="get_line_wrapped_text" qualifiers="const">
<return type="PackedStringArray">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
Returns an array of [String] repersenting each wrapped index.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_menu" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="PopupMenu" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Expose 'TextEdit's tab drawing and folding to GDScript
2019-04-24 07:59:17 +00:00
Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="get_opentype_feature" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="tag" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns OpenType feature [code]tag[/code].
</description>
</method>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<method name="get_selection_column" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_selection_from_column" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the selection begin column.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_selection_from_line" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the selection begin line.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<method name="get_selection_line" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<description>
</description>
</method>
<method name="get_selection_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextEdit.SelectionMode" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_selection_text" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the text inside the selection.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_selection_to_column" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the selection end column.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_selection_to_line" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the selection end line.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="get_tab_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
Add multiple descriptions to several classes This pull request adds several descriptions to multiple different classes. This improves the completeness of the documentation and enhances usability by doing so.
2021-07-06 11:22:53 +00:00
Returns the [TextEdit]'s' tab size.
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</description>
Move line length guidelines into CodeEdit
2021-06-30 17:03:32 +00:00
</method>
<method name="get_total_gutter_width" qualifiers="const">
Clean up and complete CodeEdit inspector and docs
2021-07-01 16:40:59 +00:00
<return type="int" />
Move line length guidelines into CodeEdit
2021-06-30 17:03:32 +00:00
<description>
</description>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</method>
Expose get_total_visible_rows as get_visible_line_count
2021-05-07 09:21:04 +00:00
<method name="get_visible_line_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Expose get_total_visible_rows as get_visible_line_count
2021-05-07 09:21:04 +00:00
<description>
Returns the number of visible lines, including wrapped text.
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="get_word_under_caret" qualifiers="const">
<return type="String">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Returns a [String] text with the word under the caret location.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Cleanup TextEdit selection methods
2021-07-09 11:42:55 +00:00
<method name="has_selection" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the user is has a selection.
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="insert_text_at_caret">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Insert the specified text at the caret position.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Update String/Comment, autocomplete and hints docs
2021-05-22 14:11:04 +00:00
<method name="is_caret_visible" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Update String/Comment, autocomplete and hints docs
2021-05-22 14:11:04 +00:00
<description>
Returns [code]true[/code] if the caret is visible on the screen.
</description>
</method>
Move symbol lookup into CodeEdit
2021-07-01 16:10:54 +00:00
<method name="is_dragging_cursor" qualifiers="const">
Clean up and complete CodeEdit inspector and docs
2021-07-01 16:40:59 +00:00
<return type="bool" />
Move symbol lookup into CodeEdit
2021-07-01 16:10:54 +00:00
<description>
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="is_gutter_clickable" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="is_gutter_drawn" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="is_gutter_overwritable" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="is_line_gutter_clickable" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
Create many types of popups on demand * LineEdit popups created on demand. * TextEdit popups created on demand. * SpinSlider popups created on demand. * ResourcePicker popups created on demand. Improves editor responsiveness.
2021-07-16 21:36:05 +00:00
<method name="is_menu_visible" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Create many types of popups on demand * LineEdit popups created on demand. * TextEdit popups created on demand. * SpinSlider popups created on demand. * ResourcePicker popups created on demand. Improves editor responsiveness.
2021-07-16 21:36:05 +00:00
<description>
Returns whether the menu is visible. Use this instead of [code]get_menu().visible[/code] to improve performance (so the creation of the menu is avoided).
</description>
</method>
Expose and cleanup TextEdit line wrap API
2021-07-09 10:52:49 +00:00
<method name="is_line_wrapped" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
Returns if the given line is wrapped.
</description>
</method>
Rename insert mode to overtype mode
2021-07-09 12:40:05 +00:00
<method name="is_overtype_mode_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Gets if the user is in overtype mode.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="menu_option">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="option" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Triggers a right-click menu action by the specified index. See [enum MenuItems] for a list of available indexes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="merge_gutters">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="from_line" type="int" />
<argument index="1" name="to_line" type="int" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="paste">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Make TextEdit cut, copy and paste overridable
2021-07-08 15:48:58 +00:00
Paste the current selection. Can be overriden with [method _paste].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="redo">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Perform redo operation.
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="remove_gutter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
Improve breakpoints and breakpoint gutter API in TextEdit Added breakpoint_gutter, is_breakpoint_gutter_enabled, set_breakpoint_gutter_enabled, get_breakpoints, remove_breakpoints. Fixed breakpoint_toggled signal not fierd when text is edited. Fixes #18026.
2018-05-30 12:02:51 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="search" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Dictionary" />
<argument index="0" name="key" type="String" />
<argument index="1" name="flags" type="int" />
<argument index="2" name="from_line" type="int" />
<argument index="3" name="from_column" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
Perform a search inside the text. Search flags can be specified in the [enum SearchFlags] enum.
TextEdit search returns a dictionary instead of Vector Easier to use than accessing elements in a Vector using indices given by an enum. Breaks compatibility on existing scripts using this functionality.
2020-05-16 21:23:46 +00:00
Returns an empty [code]Dictionary[/code] if no result was found. Otherwise, returns a [code]Dictionary[/code] containing [code]line[/code] and [code]column[/code] entries, e.g:
Docs: Port Code Examples to C# (R, S, T, U) * RenderingServer * RichTextEffect * SceneTree * SceneTreeTimer * ScriptCreateDialog * SpinBox * Sprite2D * StreamPeer * String * SurfaceTool * TextEdit * TileMap * Tree * Tween * UDPServer * UndoRedo Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-27 23:33:15 +00:00
[codeblocks]
[gdscript]
var result = search("print", SEARCH_WHOLE_WORDS, 0, 0)
if !result.empty():
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 17:41:49 +00:00
# Result found.
TextEdit search returns a dictionary instead of Vector Easier to use than accessing elements in a Vector using indices given by an enum. Breaks compatibility on existing scripts using this functionality.
2020-05-16 21:23:46 +00:00
var line_number = result.line
var column_number = result.column
Docs: Port Code Examples to C# (R, S, T, U) * RenderingServer * RichTextEffect * SceneTree * SceneTreeTimer * ScriptCreateDialog * SpinBox * Sprite2D * StreamPeer * String * SurfaceTool * TextEdit * TileMap * Tree * Tween * UDPServer * UndoRedo Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-27 23:33:15 +00:00
[/gdscript]
[csharp]
int[] result = Search("print", (uint)TextEdit.SearchFlags.WholeWords, 0, 0);
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
if (result.Length &gt; 0)
Docs: Port Code Examples to C# (R, S, T, U) * RenderingServer * RichTextEffect * SceneTree * SceneTreeTimer * ScriptCreateDialog * SpinBox * Sprite2D * StreamPeer * String * SurfaceTool * TextEdit * TileMap * Tree * Tween * UDPServer * UndoRedo Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-27 23:33:15 +00:00
{
// Result found.
int lineNumber = result[(int)TextEdit.SearchResult.Line];
int columnNumber = result[(int)TextEdit.SearchResult.Column];
}
[/csharp]
[/codeblocks]
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="select">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="from_line" type="int" />
<argument index="1" name="from_column" type="int" />
<argument index="2" name="to_line" type="int" />
<argument index="3" name="to_column" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Perform selection, from line/column to line/column.
Update TextEdit select and select_all methods
2020-07-03 11:44:34 +00:00
If [member selecting_enabled] is [code]false[/code], no selection will occur.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="select_all">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Select all the text.
Update TextEdit select and select_all methods
2020-07-03 11:44:34 +00:00
If [member selecting_enabled] is [code]false[/code], no selection will occur.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Cleanup TextEdit selection methods
2021-07-09 11:42:55 +00:00
<method name="select_word_under_caret">
<return type="void">
</return>
<description>
Selects the word under the caret.
</description>
</method>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<method name="set_caret_column">
<return type="void">
</return>
<argument index="0" name="column" type="int">
</argument>
<argument index="1" name="adjust_viewport" type="bool" default="true">
</argument>
<description>
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.
</description>
</method>
<method name="set_caret_line">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="adjust_viewport" type="bool" default="true">
</argument>
<argument index="2" name="can_be_hidden" type="bool" default="true">
</argument>
<argument index="3" name="wrap_index" type="int" default="0">
</argument>
<description>
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.
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="set_gutter_clickable">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
<argument index="1" name="clickable" type="bool" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_gutter_custom_draw">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="column" type="int" />
<argument index="1" name="object" type="Object" />
<argument index="2" name="callback" type="StringName" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_gutter_draw">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
<argument index="1" name="draw" type="bool" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_gutter_name">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
<argument index="1" name="name" type="String" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_gutter_overwritable">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
<argument index="1" name="overwritable" type="bool" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_gutter_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
<argument index="1" name="type" type="int" enum="TextEdit.GutterType" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_gutter_width">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="gutter" type="int" />
<argument index="1" name="width" type="int" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
doc: Sync classref with current source
2020-05-11 11:23:39 +00:00
<method name="set_line">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="new_text" type="String" />
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
<description>
doc: Sync classref with current source
2020-05-11 11:23:39 +00:00
Sets the text for a specific line.
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
</description>
</method>
Add custom background line colour to TextEdit and remove marked lines
2020-09-10 20:25:00 +00:00
<method name="set_line_background_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="color" type="Color" />
Add custom background line colour to TextEdit and remove marked lines
2020-09-10 20:25:00 +00:00
<description>
Sets the current background color of the line. Set to [code]Color(0, 0, 0, 0)[/code] for no color.
</description>
</method>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<method name="set_line_gutter_clickable">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
<argument index="2" name="clickable" type="bool" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_line_gutter_icon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
<argument index="2" name="icon" type="Texture2D" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_line_gutter_item_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
<argument index="2" name="color" type="Color" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_line_gutter_metadata">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
<argument index="2" name="metadata" type="Variant" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
<method name="set_line_gutter_text">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
<argument index="2" name="text" type="String" />
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<description>
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="set_opentype_feature">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="tag" type="String" />
<argument index="1" name="value" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Sets OpenType feature [code]tag[/code]. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url].
</description>
</method>
Rename insert mode to overtype mode
2021-07-09 12:40:05 +00:00
<method name="set_overtype_mode_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
If [code]True[/code] set the user into overtype mode. When the user types it will override existing text.
</description>
</method>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<method name="set_selection_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="mode" type="int" enum="TextEdit.SelectionMode" />
<argument index="1" name="line" type="int" default="-1" />
<argument index="2" name="column" type="int" default="-1" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<description>
</description>
</method>
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<method name="set_tab_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="size" type="int" />
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
<description>
Add multiple descriptions to several classes This pull request adds several descriptions to multiple different classes. This improves the completeness of the documentation and enhances usability by doing so.
2021-07-06 11:22:53 +00:00
Sets the tab size for the [TextEdit] to use.
Move indent management to CodeEdit
2021-06-15 14:05:01 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="undo">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Perform undo operation.
</description>
</method>
</methods>
<members>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<member name="caret_blink" type="bool" setter="set_caret_blink_enabled" getter="is_caret_blink_enabled" default="false">
Sets if the caret should blink.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<member name="caret_blink_speed" type="float" setter="set_caret_blink_speed" getter="get_caret_blink_speed" default="0.65">
Adds an option to move cursor with right click in TextEdit Fixes #14832 - Added an option in the editor settings/cursor to make the cursor move with right click. - If the option is activated (true by default), a right click will move the cursor before displaying context menu. - If there is a selection, a right click on it will keep it selected, a right click outside it will unselect it. - The option is available in textEdit via an inspector property (or via GDScript): caret_moving_by_right_click - The option is available in the script editor and the shader editor via the editor settings - The documentation has been updated with the new property, and a few other entries in TextEdit.xml.
2017-12-20 01:36:47 +00:00
Duration (in seconds) of a caret's blinking cycle.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<member name="caret_mid_grapheme" type="bool" setter="set_caret_mid_grapheme_enabled" getter="is_caret_mid_grapheme_enabled" default="false">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Allow moving caret, selecting and removing the individual composite character components.
Note: [kbd]Backspace[/kbd] is always removing individual composite character components.
</member>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<member name="caret_move_on_right_click" type="bool" setter="set_move_caret_on_right_click_enabled" getter="is_move_caret_on_right_click_enabled" default="true">
If [code]true[/code], a right-click moves the caret at the mouse position before displaying the context menu.
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]false[/code], the context menu disregards mouse location.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<member name="caret_type" type="int" setter="set_caret_type" getter="get_caret_type" enum="TextEdit.CaretType" default="0">
Set the type of caret to draw.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled" default="true">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
If [code]true[/code], a right-click displays the context menu.
classref: Sync with current source [ci skip]
2017-11-13 08:24:36 +00:00
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<member name="draw_control_chars" type="bool" setter="set_draw_control_chars" getter="get_draw_control_chars" default="false">
If [code]true[/code], control characters are displayed.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="draw_spaces" type="bool" setter="set_draw_spaces" getter="is_drawing_spaces" default="false">
Expose TextEdit's drawSpaces feature to GDScript
2019-05-01 09:31:10 +00:00
If [code]true[/code], the "space" character will have a visible representation.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="draw_tabs" type="bool" setter="set_draw_tabs" getter="is_drawing_tabs" default="false">
doc: Sync classref with current source
2019-05-21 11:26:37 +00:00
If [code]true[/code], the "tab" character will have a visible representation.
</member>
Rename readonly to editable
2021-07-09 13:05:52 +00:00
<member name="editable" type="bool" setter="set_editable" getter="is_editable" default="true">
If [code]false[/code], existing text cannot be modified and new text cannot be added.
</member>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 11:34:03 +00:00
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled" default="false">
Document TextEdit node
2019-06-13 09:12:52 +00:00
If [code]true[/code], all occurrences of the selected text will be highlighted.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the line containing the cursor is highlighted.
classref: Sync with current source [ci skip]
2017-10-24 17:22:37 +00:00
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</member>
doc: Sync classref with current source Fix wrong hyperlinks in Control and Tree.
2019-08-22 12:49:30 +00:00
<member name="minimap_draw" type="bool" setter="draw_minimap" getter="is_drawing_minimap" default="false">
Add documentation for minimap_draw and minimap_width
2020-07-03 12:42:43 +00:00
If [code]true[/code], a minimap is shown, providing an outline of your source code.
doc: Sync classref with current source Fix wrong hyperlinks in Control and Tree.
2019-08-22 12:49:30 +00:00
</member>
<member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80">
Add documentation for minimap_draw and minimap_width
2020-07-03 12:42:43 +00:00
The width, in pixels, of the minimap.
doc: Sync classref with current source Fix wrong hyperlinks in Control and Tree.
2019-08-22 12:49:30 +00:00
</member>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 11:34:03 +00:00
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" override="true" enum="Control.CursorShape" default="1" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color" default="false">
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 13:11:45 +00:00
If [code]true[/code], custom [code]font_selected_color[/code] will be used for selected text.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</member>
doc: Sync classref with current source
2020-01-12 13:30:21 +00:00
<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0">
Scroll faster when holding Alt in TextEdit (and script editor) This feature is inspired by a similar feature found in Visual Studio Code.
2021-05-09 23:27:54 +00:00
If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels.
doc: Sync classref with current source
2020-01-12 13:30:21 +00:00
</member>
<member name="scroll_vertical" type="float" setter="set_v_scroll" getter="get_v_scroll" default="0.0">
Scroll faster when holding Alt in TextEdit (and script editor) This feature is inspired by a similar feature found in Visual Studio Code.
2021-05-09 23:27:54 +00:00
If there is a vertical scrollbar, this determines the current vertical scroll value in line numbers, starting at 0 for the top line.
doc: Sync classref with current source
2020-01-12 13:30:21 +00:00
</member>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
<member name="selecting_enabled" type="bool" setter="set_selecting_enabled" getter="is_selecting_enabled" default="true">
Add documentation for selecting_enabled
2020-07-03 11:24:40 +00:00
If [code]true[/code], text can be selected.
If [code]false[/code], text can not be selected by the user or by the [method select] or [method select_all] methods.
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
</member>
<member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true">
Add documentation for shortcut_keys_enabled
2020-07-03 08:03:56 +00:00
If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled.
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled" default="false">
Document TextEdit node
2019-06-13 09:12:52 +00:00
If [code]true[/code], sets the [code]step[/code] of the scrollbars to [code]0.25[/code] which results in smoother scrolling.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="Control.StructuredTextParser" default="0">
Set BiDi algorithm override for the structured text.
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" default="[]">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Set additional options for BiDi override.
</member>
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<member name="syntax_highlighter" type="SyntaxHighlighter" setter="set_syntax_highlighter" getter="get_syntax_highlighter">
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Sets the [SyntaxHighlighter] to use.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
classref: Sync with current source [ci skip]
2017-11-13 08:24:36 +00:00
String value of the [TextEdit].
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="Control.TextDirection" default="0">
Base text writing direction.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed" default="80.0">
fixes #25707 documentation of v_scroll_speed Fixes #25707 Update TextEdit.xml
2019-04-12 12:04:15 +00:00
Vertical scroll sensitivity.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
Add option to disable virtual keyboard for TextEdit Adding support for disabling virtual keyboard on mobile platforms, in order to make it consistent with LineEdit. It allows implementing a custom virtual keyboard.
2020-08-09 09:06:36 +00:00
<member name="virtual_keyboard_enabled" type="bool" setter="set_virtual_keyboard_enabled" getter="is_virtual_keyboard_enabled" default="true">
If [code]true[/code], the native virtual keyboard is shown when focused on platforms that support it.
</member>
Expose and cleanup TextEdit line wrap API
2021-07-09 10:52:49 +00:00
<member name="wrap_mode" type="int" setter="set_line_wrapping_mode" getter="get_line_wrapping_mode" enum="TextEdit.LineWrappingMode" default="0">
Sets the line wrapping mode to use.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<signal name="caret_changed">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
Emitted when the caret changes position.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<signal name="gutter_added">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</signal>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<signal name="gutter_clicked">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<argument index="0" name="line" type="int" />
<argument index="1" name="gutter" type="int" />
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 19:39:09 +00:00
<description>
</description>
</signal>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<signal name="gutter_removed">
<description>
</description>
</signal>
<signal name="lines_edited_from">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<argument index="0" name="from_line" type="int" />
<argument index="1" name="to_line" type="int" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signal name="text_changed">
<description>
Emitted when the text changes.
</description>
</signal>
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SEARCH_MATCH_CASE" value="1" enum="SearchFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Match case when searching.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SEARCH_WHOLE_WORDS" value="2" enum="SearchFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Match whole words when searching.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SEARCH_BACKWARDS" value="4" enum="SearchFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Search from end to beginning.
</constant>
Cleanup and rename caret operations
2021-07-08 17:35:56 +00:00
<constant name="CARET_TYPE_LINE" value="0" enum="CaretType">
Vertical line caret.
</constant>
<constant name="CARET_TYPE_BLOCK" value="1" enum="CaretType">
Block caret.
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<constant name="SELECTION_MODE_NONE" value="0" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_SHIFT" value="1" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_POINTER" value="2" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_WORD" value="3" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_LINE" value="4" enum="SelectionMode">
</constant>
Expose and cleanup TextEdit line wrap API
2021-07-09 10:52:49 +00:00
<constant name="LINE_WRAPPING_NONE" value="0" enum="LineWrappingMode">
Line wrapping is disabled.
</constant>
<constant name="LINE_WRAPPING_BOUNDARY" value="1" enum="LineWrappingMode">
Line wrapping occurs at the control boundary, beyond what would normally be visible.
</constant>
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
<constant name="GUTTER_TYPE_STRING" value="0" enum="GutterType">
</constant>
Fixed typos in `TextEdit::GutterType` enum
2021-07-19 08:16:00 +00:00
<constant name="GUTTER_TYPE_ICON" value="1" enum="GutterType">
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
</constant>
Fixed typos in `TextEdit::GutterType` enum
2021-07-19 08:16:00 +00:00
<constant name="GUTTER_TYPE_CUSTOM" value="2" enum="GutterType">
doc: Sync classref with current source Bind missing enums.
2020-09-11 10:22:10 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MENU_CUT" value="0" enum="MenuItems">
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
Cuts (copies and clears) the selected text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MENU_COPY" value="1" enum="MenuItems">
Adds an option to move cursor with right click in TextEdit Fixes #14832 - Added an option in the editor settings/cursor to make the cursor move with right click. - If the option is activated (true by default), a right click will move the cursor before displaying context menu. - If there is a selection, a right click on it will keep it selected, a right click outside it will unselect it. - The option is available in textEdit via an inspector property (or via GDScript): caret_moving_by_right_click - The option is available in the script editor and the shader editor via the editor settings - The documentation has been updated with the new property, and a few other entries in TextEdit.xml.
2017-12-20 01:36:47 +00:00
Copies the selected text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MENU_PASTE" value="2" enum="MenuItems">
Adds an option to move cursor with right click in TextEdit Fixes #14832 - Added an option in the editor settings/cursor to make the cursor move with right click. - If the option is activated (true by default), a right click will move the cursor before displaying context menu. - If there is a selection, a right click on it will keep it selected, a right click outside it will unselect it. - The option is available in textEdit via an inspector property (or via GDScript): caret_moving_by_right_click - The option is available in the script editor and the shader editor via the editor settings - The documentation has been updated with the new property, and a few other entries in TextEdit.xml.
2017-12-20 01:36:47 +00:00
Pastes the clipboard text over the selected text (or at the cursor's position).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MENU_CLEAR" value="3" enum="MenuItems">
Adds an option to move cursor with right click in TextEdit Fixes #14832 - Added an option in the editor settings/cursor to make the cursor move with right click. - If the option is activated (true by default), a right click will move the cursor before displaying context menu. - If there is a selection, a right click on it will keep it selected, a right click outside it will unselect it. - The option is available in textEdit via an inspector property (or via GDScript): caret_moving_by_right_click - The option is available in the script editor and the shader editor via the editor settings - The documentation has been updated with the new property, and a few other entries in TextEdit.xml.
2017-12-20 01:36:47 +00:00
Erases the whole [TextEdit] text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MENU_SELECT_ALL" value="4" enum="MenuItems">
Adds an option to move cursor with right click in TextEdit Fixes #14832 - Added an option in the editor settings/cursor to make the cursor move with right click. - If the option is activated (true by default), a right click will move the cursor before displaying context menu. - If there is a selection, a right click on it will keep it selected, a right click outside it will unselect it. - The option is available in textEdit via an inspector property (or via GDScript): caret_moving_by_right_click - The option is available in the script editor and the shader editor via the editor settings - The documentation has been updated with the new property, and a few other entries in TextEdit.xml.
2017-12-20 01:36:47 +00:00
Selects the whole [TextEdit] text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MENU_UNDO" value="5" enum="MenuItems">
Adds an option to move cursor with right click in TextEdit Fixes #14832 - Added an option in the editor settings/cursor to make the cursor move with right click. - If the option is activated (true by default), a right click will move the cursor before displaying context menu. - If there is a selection, a right click on it will keep it selected, a right click outside it will unselect it. - The option is available in textEdit via an inspector property (or via GDScript): caret_moving_by_right_click - The option is available in the script editor and the shader editor via the editor settings - The documentation has been updated with the new property, and a few other entries in TextEdit.xml.
2017-12-20 01:36:47 +00:00
Undoes the previous action.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
<constant name="MENU_REDO" value="6" enum="MenuItems">
Document TextEdit node
2019-06-13 09:12:52 +00:00
Redoes the previous action.
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
</constant>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<constant name="MENU_DIR_INHERITED" value="7" enum="MenuItems">
Sets text direction to inherited.
</constant>
<constant name="MENU_DIR_AUTO" value="8" enum="MenuItems">
Sets text direction to automatic.
</constant>
<constant name="MENU_DIR_LTR" value="9" enum="MenuItems">
Sets text direction to left-to-right.
</constant>
<constant name="MENU_DIR_RTL" value="10" enum="MenuItems">
Sets text direction to right-to-left.
</constant>
<constant name="MENU_DISPLAY_UCC" value="11" enum="MenuItems">
Toggles control character display.
</constant>
<constant name="MENU_INSERT_LRM" value="12" enum="MenuItems">
Inserts left-to-right mark (LRM) character.
</constant>
<constant name="MENU_INSERT_RLM" value="13" enum="MenuItems">
Inserts right-to-left mark (RLM) character.
</constant>
<constant name="MENU_INSERT_LRE" value="14" enum="MenuItems">
Inserts start of left-to-right embedding (LRE) character.
</constant>
<constant name="MENU_INSERT_RLE" value="15" enum="MenuItems">
Inserts start of right-to-left embedding (RLE) character.
</constant>
<constant name="MENU_INSERT_LRO" value="16" enum="MenuItems">
Inserts start of left-to-right override (LRO) character.
</constant>
<constant name="MENU_INSERT_RLO" value="17" enum="MenuItems">
Inserts start of right-to-left override (RLO) character.
</constant>
<constant name="MENU_INSERT_PDF" value="18" enum="MenuItems">
Inserts pop direction formatting (PDF) character.
</constant>
<constant name="MENU_INSERT_ALM" value="19" enum="MenuItems">
Inserts Arabic letter mark (ALM) character.
</constant>
<constant name="MENU_INSERT_LRI" value="20" enum="MenuItems">
Inserts left-to-right isolate (LRI) character.
</constant>
<constant name="MENU_INSERT_RLI" value="21" enum="MenuItems">
Inserts right-to-left isolate (RLI) character.
</constant>
<constant name="MENU_INSERT_FSI" value="22" enum="MenuItems">
Inserts first strong isolate (FSI) character.
</constant>
<constant name="MENU_INSERT_PDI" value="23" enum="MenuItems">
Inserts pop direction isolate (PDI) character.
</constant>
<constant name="MENU_INSERT_ZWJ" value="24" enum="MenuItems">
Inserts zero width joiner (ZWJ) character.
</constant>
<constant name="MENU_INSERT_ZWNJ" value="25" enum="MenuItems">
Inserts zero width non-joiner (ZWNJ) character.
</constant>
<constant name="MENU_INSERT_WJ" value="26" enum="MenuItems">
Inserts word joiner (WJ) character.
</constant>
<constant name="MENU_INSERT_SHY" value="27" enum="MenuItems">
Inserts soft hyphen (SHY) character.
</constant>
<constant name="MENU_MAX" value="28" enum="MenuItems">
Document TextEdit node
2019-06-13 09:12:52 +00:00
Represents the size of the [enum MenuItems] enum.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="background_color" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Sets the background [Color] of this [TextEdit].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="caret_background_color" data_type="color" type="Color" default="Color(0, 0, 0, 1)">
[Color] of the text behind the caret when block caret is enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="caret_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 1)">
[Color] of the caret.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="current_line_color" data_type="color" type="Color" default="Color(0.25, 0.25, 0.26, 0.8)">
Background [Color] of the line containing the caret.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="focus" data_type="style" type="StyleBox">
Sets the [StyleBox] when in focus.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font" data_type="font" type="Font">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the default [Font].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 1)">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the font [Color].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
The tint of text outline of the [TextEdit].
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_readonly_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 0.5)">
Sets the font [Color] when [member readonly] is enabled.
doc: Sync classref with current source
2019-06-26 14:02:47 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_selected_color" data_type="color" type="Color" default="Color(0, 0, 0, 1)">
Update TextEdit docs - explaining 'override_selected_font_color' role
2020-04-19 21:33:01 +00:00
Sets the [Color] of the selected text. [member override_selected_font_color] has to be enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_size" data_type="font_size" type="int">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Sets default font size.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="line_spacing" data_type="constant" type="int" default="4">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the spacing between the lines.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="normal" data_type="style" type="StyleBox">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the [StyleBox] of this [TextEdit].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="outline_size" data_type="constant" type="int" default="0">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
The size of the text outline.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="read_only" data_type="style" type="StyleBox">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled.
doc: Sync classref with current source
2017-12-07 07:23:08 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="selection_color" data_type="color" type="Color" default="Color(0.49, 0.49, 0.49, 1)">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the highlight [Color] of text selections.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="space" data_type="icon" type="Texture2D">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Sets a custom [Texture2D] for space text characters.
doc: Sync classref with current source
2019-05-21 11:26:37 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="tab" data_type="icon" type="Texture2D">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
Sets a custom [Texture2D] for tab text characters.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="word_highlighted_color" data_type="color" type="Color" default="Color(0.8, 0.9, 0.9, 0.15)">
doctool: Fix writing theme_item descriptions We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-25 10:57:35 +00:00
Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>