asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve TextEdit and CodeEdit documentation

Browse source
This commit is contained in:
kit 2024-09-30 13:34:26 -04:00
parent 76a135926a
commit 859e223fe7
3 changed files with 49 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
doc/classes/CodeEdit.xml
View file

@ -153,7 +153,7 @@
<method name="do_indent">
<return type="void" />
<description>
Perform an indent as if the user activated the "ui_text_indent" action.
Perform an indent as if the user activated the [member ProjectSettings.input/ui_text_indent] action. If there is a selection this indents lines like [method indent_lines], otherwise indentation is added at the caret. Uses spaces or a tab depending on [member indent_use_spaces].
</description>
</method>
<method name="duplicate_lines">
@ -276,7 +276,7 @@
<method name="get_folded_lines" qualifiers="const">
<return type="int[]" />
<description>
Returns all lines that are current folded.
Returns all lines that are currently folded.
</description>
</method>
<method name="get_text_for_code_completion" qualifiers="const">
@ -330,7 +330,7 @@
<method name="indent_lines">
<return type="void" />
<description>
Indents selected lines, or in the case of no selection the caret line by one.
Indents all lines that are selected or have a caret on them. Uses spaces or a tab depending on [member indent_use_spaces]. See [method unindent_lines].
</description>
</method>
<method name="is_in_comment" qualifiers="const">
@ -353,42 +353,42 @@
<return type="bool" />
<param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is bookmarked or not.
Returns [code]true[/code] if the line is bookmarked. See [method set_line_as_bookmarked].
</description>
</method>
<method name="is_line_breakpointed" qualifiers="const">
<return type="bool" />
<param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is breakpointed or not.
Returns [code]true[/code] if the line is breakpointed. See [method set_line_as_breakpoint].
</description>
</method>
<method name="is_line_code_region_end" qualifiers="const">
<return type="bool" />
<param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is a code region end.
Returns [code]true[/code] if the line is a code region end. See [method set_code_region_tags].
</description>
</method>
<method name="is_line_code_region_start" qualifiers="const">
<return type="bool" />
<param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is a code region start.
Returns [code]true[/code] if the line is a code region start. See [method set_code_region_tags].
</description>
</method>
<method name="is_line_executing" qualifiers="const">
<return type="bool" />
<param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is marked as executing or not.
Returns [code]true[/code] if the line is marked as executing. See [method set_line_as_executing].
</description>
</method>
<method name="is_line_folded" qualifiers="const">
<return type="bool" />
<param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is folded or not.
Returns [code]true[/code] if the line is folded. See [method fold_line].
</description>
</method>
<method name="move_lines_down">
@ -442,7 +442,7 @@
<return type="void" />
<param index="0" name="draw_below" type="bool" />
<description>
Sets if the code hint should draw below the text.
If [code]true[/code], the code hint will draw below the main caret. If [code]false[/code], the code hint will draw above the main caret. See [method set_code_hint].
</description>
</method>
<method name="set_code_region_tags">
@ -458,7 +458,7 @@
<param index="0" name="line" type="int" />
<param index="1" name="bookmarked" type="bool" />
<description>
Sets the line as bookmarked.
Sets the line as bookmarked. If [code]true[/code] and [member gutters_draw_bookmarks] is [code]true[/code], draws the [theme_item bookmark] icon in the gutter for this line. See [method get_bookmarked_lines] and [method is_line_bookmarked].
</description>
</method>
<method name="set_line_as_breakpoint">
@ -466,7 +466,7 @@
<param index="0" name="line" type="int" />
<param index="1" name="breakpointed" type="bool" />
<description>
Sets the line as breakpointed.
Sets the line as a breakpoint. If [code]true[/code] and [member gutters_draw_breakpoints_gutter] is [code]true[/code], draws the [theme_item breakpoint] icon in the gutter for this line. See [method get_breakpointed_lines] and [method is_line_breakpointed].
</description>
</method>
<method name="set_line_as_executing">
@ -474,7 +474,7 @@
<param index="0" name="line" type="int" />
<param index="1" name="executing" type="bool" />
<description>
Sets the line as executing.
Sets the line as executing. If [code]true[/code] and [member gutters_draw_executing_lines] is [code]true[/code], draws the [theme_item executing_line] icon in the gutter for this line. See [method get_executing_lines] and [method is_line_executing].
</description>
</method>
<method name="set_symbol_lookup_word_as_valid">
@ -500,20 +500,20 @@
<method name="unfold_all_lines">
<return type="void" />
<description>
Unfolds all lines, folded or not.
Unfolds all lines that are folded.
</description>
</method>
<method name="unfold_line">
<return type="void" />
<param index="0" name="line" type="int" />
<description>
Unfolds all lines that were previously folded.
Unfolds the line if it is folded or if it is hidden under a folded line.
</description>
</method>
<method name="unindent_lines">
<return type="void" />
<description>
Unindents selected lines, or in the case of no selection the caret line by one. Same as performing "ui_text_unindent" action.
Unindents all lines that are selected or have a caret on them. Uses spaces or a tab depending on [member indent_use_spaces]. Equivalent to performing the [member ProjectSettings.input/ui_text_dedent] action. See [method indent_lines].
</description>
</method>
<method name="update_code_completion_options">
@ -527,16 +527,16 @@
</methods>
<members>
<member name="auto_brace_completion_enabled" type="bool" setter="set_auto_brace_completion_enabled" getter="is_auto_brace_completion_enabled" default="false">
Sets whether brace pairs should be autocompleted.
If [code]true[/code], uses [member auto_brace_completion_pairs] to automatically insert the closing brace when the opening brace is inserted by typing or autocompletion. Also automatically removes the closing brace when using backspace on the opening brace.
</member>
<member name="auto_brace_completion_highlight_matching" type="bool" setter="set_highlight_matching_braces_enabled" getter="is_highlight_matching_braces_enabled" default="false">
Highlight mismatching brace pairs.
If [code]true[/code], highlights brace pairs when the caret is on either one using [member auto_brace_completion_pairs]. If matching, the pairs will be underlined. If a brace is unmatched, it is colored with [theme_item brace_mismatch_color].
</member>
<member name="auto_brace_completion_pairs" type="Dictionary" setter="set_auto_brace_completion_pairs" getter="get_auto_brace_completion_pairs" default="{ &quot;\&quot;&quot;: &quot;\&quot;&quot;, &quot;&apos;&quot;: &quot;&apos;&quot;, &quot;(&quot;: &quot;)&quot;, &quot;[&quot;: &quot;]&quot;, &quot;{&quot;: &quot;}&quot; }">
Sets the brace pairs to be autocompleted.
Sets the brace pairs to be autocompleted. The key is the the opening brace and the value is the closing brace that matches it. A brace is a [String] made of symbols. See [member auto_brace_completion_enabled] and [member auto_brace_completion_highlight_matching].
</member>
<member name="code_completion_enabled" type="bool" setter="set_code_completion_enabled" getter="is_code_completion_enabled" default="false">
Sets whether code completion is allowed.
If [code]true[/code], requests code completion when the [member ProjectSettings.input/ui_text_completion_query] input action is pressed. See [method _request_code_completion] or [signal code_completion_requested] to handle it.
</member>
<member name="code_completion_prefixes" type="String[]" setter="set_code_completion_prefixes" getter="get_code_completion_prefixes" default="[]">
Sets prefixes that will trigger code completion.
@ -548,28 +548,28 @@
Sets the string delimiters. All existing string delimiters will be removed.
</member>
<member name="gutters_draw_bookmarks" type="bool" setter="set_draw_bookmarks_gutter" getter="is_drawing_bookmarks_gutter" default="false">
Sets if bookmarked should be drawn in the gutter. This gutter is shared with breakpoints and executing lines.
If [code]true[/code], bookmarks are drawn in the gutter. This gutter is shared with breakpoints and executing lines. See [method set_line_as_bookmarked].
</member>
<member name="gutters_draw_breakpoints_gutter" type="bool" setter="set_draw_breakpoints_gutter" getter="is_drawing_breakpoints_gutter" default="false">
Sets if breakpoints should be drawn in the gutter. This gutter is shared with bookmarks and executing lines.
If [code]true[/code], breakpoints are drawn in the gutter. This gutter is shared with bookmarks and executing lines. Clicking the gutter will toggle the breakpoint for the line, see [method set_line_as_breakpoint].
</member>
<member name="gutters_draw_executing_lines" type="bool" setter="set_draw_executing_lines_gutter" getter="is_drawing_executing_lines_gutter" default="false">
Sets if executing lines should be marked in the gutter. This gutter is shared with breakpoints and bookmarks lines.
If [code]true[/code], executing lines are marked in the gutter. This gutter is shared with breakpoints and bookmarks. See [method set_line_as_executing].
</member>
<member name="gutters_draw_fold_gutter" type="bool" setter="set_draw_fold_gutter" getter="is_drawing_fold_gutter" default="false">
Sets if foldable lines icons should be drawn in the gutter.
If [code]true[/code], the fold gutter is drawn. In this gutter, the [theme_item can_fold_code_region] icon is drawn for each foldable line (see [method can_fold_line]) and the [theme_item folded_code_region] icon is drawn for each folded line (see [method is_line_folded]). These icons can be clicked to toggle the fold state, see [method toggle_foldable_line]. [member line_folding] must be [code]true[/code] to show icons.
</member>
<member name="gutters_draw_line_numbers" type="bool" setter="set_draw_line_numbers" getter="is_draw_line_numbers_enabled" default="false">
Sets if line numbers should be drawn in the gutter.
If [code]true[/code], the line number gutter is drawn. Line numbers start at [code]1[/code] and are incremented for each line of text. Clicking and dragging in the line number gutter will select entire lines of text.
</member>
<member name="gutters_zero_pad_line_numbers" type="bool" setter="set_line_numbers_zero_padded" getter="is_line_numbers_zero_padded" default="false">
Sets if line numbers drawn in the gutter are zero padded.
If [code]true[/code], line numbers drawn in the gutter are zero padded based on the highest number. [member gutters_draw_line_numbers] must be [code]true[/code].
</member>
<member name="indent_automatic" type="bool" setter="set_auto_indent_enabled" getter="is_auto_indent_enabled" default="false">
Sets whether automatic indent are enabled, this will add an extra indent if a prefix or brace is found.
If [code]true[/code], an extra indent will automatically be added when adding a new line if a prefix in [member indent_automatic_prefixes] is found. If a brace pair opening key is found (see [member auto_brace_completion_pairs]), the matching closing brace will be moved to another new line.
</member>
<member name="indent_automatic_prefixes" type="String[]" setter="set_auto_indent_prefixes" getter="get_auto_indent_prefixes" default="[&quot;:&quot;, &quot;{&quot;, &quot;[&quot;, &quot;(&quot;]">
Prefixes to trigger an automatic indent.
Prefixes to trigger an automatic indent. [member indent_automatic] must be [code]true[/code].
</member>
<member name="indent_size" type="int" setter="set_indent_size" getter="get_indent_size" default="4">
Size of the tabulation indent (one [kbd]Tab[/kbd] press) in characters. If [member indent_use_spaces] is enabled the number of spaces to use.
@ -579,7 +579,8 @@
</member>
<member name="layout_direction" type="int" setter="set_layout_direction" getter="get_layout_direction" overrides="Control" enum="Control.LayoutDirection" default="2" />
<member name="line_folding" type="bool" setter="set_line_folding_enabled" getter="is_line_folding_enabled" default="false">
Sets whether line folding is allowed.
If [code]false[/code], line folding methods like [method fold_line] will not work and [method can_fold_line] will always return [code]false[/code].
If [code]true[/code], lines can be folded. See [member gutters_draw_fold_gutter].
</member>
<member name="line_length_guidelines" type="int[]" setter="set_line_length_guidelines" getter="get_line_length_guidelines" default="[]">
Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently.
@ -598,7 +599,7 @@
</signal>
<signal name="code_completion_requested">
<description>
Emitted when the user requests code completion.
Emitted when the user requests code completion. [member code_completion_enabled] must be [code]true[/code]. Will not be sent if [method _request_code_completion] is overridden.
</description>
</signal>
<signal name="symbol_lookup">

2
doc/classes/EditorSettings.xml
View file

@ -1258,7 +1258,7 @@
If [code]true[/code], adds [url=$DOCS_URL/tutorials/scripting/gdscript/static_typing.html]GDScript static typing[/url] hints such as [code]-&gt; void[/code] and [code]: int[/code] when using code autocompletion or when creating onready variables by drag and dropping nodes into the script editor while pressing the [kbd]Ctrl[/kbd] key. If [code]true[/code], newly created scripts will also automatically have type hints added to their method parameters and return types.
</member>
<member name="text_editor/completion/auto_brace_complete" type="bool" setter="" getter="">
If [code]true[/code], automatically completes braces when making use of code completion.
If [code]true[/code], automatically inserts the matching closing brace when the opening brace is inserted by typing or autocompletion. Also automatically removes the closing brace when using backspace on the opening brace. This includes brackets [code]() {} [][/code], string quotation marks [code]'' ""[/code], and comments [code]/**/[/code] if the language supports it.
</member>
<member name="text_editor/completion/code_complete_delay" type="float" setter="" getter="">
The delay in seconds after which autocompletion suggestions should be displayed when the user stops typing.

34
doc/classes/TextEdit.xml
View file

@ -656,7 +656,7 @@
<method name="get_total_visible_line_count" qualifiers="const">
<return type="int" />
<description>
Returns the number of lines that may be drawn.
Returns the number of lines in the text, including wrapped lines and excluding folded lines. If [member wrap_mode] is set to [constant LINE_WRAPPING_NONE] and no lines are folded (see [method CodeEdit.is_line_folded]) then this is equivalent to [method get_line_count]. See [method get_visible_line_count_in_range] for a limited range of lines.
</description>
</method>
<method name="get_v_scroll_bar" qualifiers="const">
@ -674,7 +674,7 @@
<method name="get_visible_line_count" qualifiers="const">
<return type="int" />
<description>
Returns the number of visible lines, including wrapped text.
Returns the maximum number of lines that can visually fit in the control, rounded down.
</description>
</method>
<method name="get_visible_line_count_in_range" qualifiers="const">
@ -682,7 +682,7 @@
<param index="0" name="from_line" type="int" />
<param index="1" name="to_line" type="int" />
<description>
Returns the total number of visible + wrapped lines between the two lines.
Returns the total number of visible lines (including wrapped text) between the [param from_line] and [param to_line], inclusive. If the range covers all lines it is equivalent to [method get_total_visible_line_count].
</description>
</method>
<method name="get_word_at_pos" qualifiers="const">
@ -777,21 +777,21 @@
<return type="bool" />
<param index="0" name="gutter" type="int" />
<description>
Returns whether the gutter is clickable.
Returns [code]true[/code] if the gutter is clickable. See [method set_gutter_clickable].
</description>
</method>
<method name="is_gutter_drawn" qualifiers="const">
<return type="bool" />
<param index="0" name="gutter" type="int" />
<description>
Returns whether the gutter is currently drawn.
Returns [code]true[/code] if the gutter is currently drawn. See [method set_gutter_draw].
</description>
</method>
<method name="is_gutter_overwritable" qualifiers="const">
<return type="bool" />
<param index="0" name="gutter" type="int" />
<description>
Returns whether the gutter is overwritable.
Returns [code]true[/code] if the gutter is overwritable. See [method set_gutter_overwritable].
</description>
</method>
<method name="is_in_mulitcaret_edit" qualifiers="const">
@ -805,7 +805,7 @@
<param index="0" name="line" type="int" />
<param index="1" name="gutter" type="int" />
<description>
Returns whether the gutter on the given line is clickable.
Returns [code]true[/code] if the gutter on the given line is clickable. See [method set_line_gutter_clickable].
</description>
</method>
<method name="is_line_wrapped" qualifiers="const">
@ -818,7 +818,7 @@
<method name="is_menu_visible" qualifiers="const">
<return type="bool" />
<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).
Returns [code]true[/code] if the menu is visible. Use this instead of [code]get_menu().visible[/code] to improve performance (so the creation of the menu is avoided). See [method get_menu].
</description>
</method>
<method name="is_mouse_over_selection" qualifiers="const">
@ -826,13 +826,13 @@
<param index="0" name="edges" type="bool" />
<param index="1" name="caret_index" type="int" default="-1" />
<description>
Returns whether the mouse is over selection. If [param edges] is [code]true[/code], the edges are considered part of the selection.
Returns [code]true[/code] if the mouse is over a selection. If [param edges] is [code]true[/code], the edges are considered part of the selection.
</description>
</method>
<method name="is_overtype_mode_enabled" qualifiers="const">
<return type="bool" />
<description>
Returns whether the user is in overtype mode.
Returns [code]true[/code] if the user is in overtype mode. See [method set_overtype_mode_enabled].
</description>
</method>
<method name="menu_option">
@ -847,7 +847,7 @@
<param index="0" name="from_line" type="int" />
<param index="1" name="to_line" type="int" />
<description>
Merge the gutters from [param from_line] into [param to_line]. Only overwritable gutters will be copied.
Merge the gutters from [param from_line] into [param to_line]. Only overwritable gutters will be copied. See [method set_gutter_overwritable].
</description>
</method>
<method name="merge_overlapping_carets">
@ -1013,7 +1013,7 @@
<param index="0" name="gutter" type="int" />
<param index="1" name="clickable" type="bool" />
<description>
Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter.
If [code]true[/code], the mouse cursor will change to a pointing hand ([constant Control.CURSOR_POINTING_HAND]) when hovering over the gutter. See [method is_gutter_clickable] and [method set_line_gutter_clickable].
</description>
</method>
<method name="set_gutter_custom_draw">
@ -1029,7 +1029,7 @@
<param index="0" name="gutter" type="int" />
<param index="1" name="draw" type="bool" />
<description>
Sets whether the gutter should be drawn.
If [code]true[/code] the gutter will be drawn. The gutter type ([method set_gutter_type]) will determine how it is drawn. See [method is_gutter_drawn].
</description>
</method>
<method name="set_gutter_name">
@ -1045,7 +1045,7 @@
<param index="0" name="gutter" type="int" />
<param index="1" name="overwritable" type="bool" />
<description>
Sets the gutter to overwritable. See [method merge_gutters].
If [code]true[/code], the gutter lines can be overridden when using [method merge_gutters]. See [method is_gutter_overwritable].
</description>
</method>
<method name="set_gutter_type">
@ -1111,7 +1111,7 @@
<param index="1" name="gutter" type="int" />
<param index="2" name="clickable" type="bool" />
<description>
If [param clickable] is [code]true[/code], makes the [param gutter] on [param line] clickable. See [signal gutter_clicked].
If [param clickable] is [code]true[/code], makes the [param gutter] on [param line] clickable. This is like [method set_gutter_clickable], but for a single line. If [method is_gutter_clickable] is [code]true[/code], this will not have an effect. See [method is_line_gutter_clickable] and [signal gutter_clicked].
</description>
</method>
<method name="set_line_gutter_icon">
@ -1154,7 +1154,7 @@
<return type="void" />
<param index="0" name="enabled" type="bool" />
<description>
If [code]true[/code], sets the user into overtype mode. When the user types in this mode, it will override existing text.
If [code]true[/code], sets the user into overtype mode. When the user types in this mode, it will override existing text. The [member ProjectSettings.input/ui_text_toggle_insert_mode] action toggles overtype mode. See [method is_overtype_mode_enabled].
</description>
</method>
<method name="set_search_flags">
@ -1269,7 +1269,7 @@
If [code]false[/code], the context menu ignores mouse location.
</member>
<member name="caret_multiple" type="bool" setter="set_multiple_carets_enabled" getter="is_multiple_carets_enabled" default="true">
Sets if multiple carets are allowed.
If [code]true[/code], allows multiple carets. Left-clicking with [kbd]Alt[/kbd] adds a new caret. See [method add_caret] and [method get_caret_count].
</member>
<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.