diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 42a6df866f1..4076198df66 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -8,6 +8,91 @@ + + + + + + + Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced. + + + + + + + + + Override this method to define what items in [code]candidates[/code] should be displayed. + Both [code]candidates[/code] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. + + + + + + + + + Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed. + + + + + + + + + + + + + + + + + + + Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list. + [b]Note[/b]: This list will replace all current candidates. + + + + + + + + + + + + + Adds a comment delimiter. + Both the start and end keys must be symbols. Only the start key has to be unique. + Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + + + + + + + + + + + + + Adds a string delimiter. + Both the start and end keys must be symbols. Only the start key has to be unique. + Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + + + + + + + Cancels the autocomplete menu. + + @@ -20,12 +105,35 @@ + + + + + Removes all comment delimiters. + + + + + + + Removes all string delimiters. + + + + + + + + + Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged. + + @@ -38,12 +146,128 @@ + + + + + + + Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values: + [code]kind[/code]: [enum CodeCompletionKind] + [code]display_text[/code]: Text that is shown on the autocomplete menu. + [code]insert_text[/code]: Text that is to be inserted when this item is selected. + [code]font_color[/code]: Color of the text on the autocomplete menu. + [code]icon[/code]: Icon to draw on the autocomplete menu. + [code]default_value[/code]: Value of the symbol. + + + + + + + Gets all completion options, see [method get_code_completion_option] for return content. + + + + + + + Gets the index of the current selected completion option. + + + + + + + + + Gets the end key for a string or comment region index. + + + + + + + + + + + If [code]line[/code] [code]column[/code] is in a string or comment, returns the end position of the region. If not or no end could be found, both [Vector2] values will be [code]-1[/code]. + + + + + + + + + Gets the start key for a string or comment region index. + + + + + + + + + + + If [code]line[/code] [code]column[/code] is in a string or comment, returns the start position of the region. If not or no start could be found, both [Vector2] values will be [code]-1[/code]. + + + + + + + Returns the full text with char [code]0xFFFF[/code] at the caret location. + + + + + + + + + Returns [code]true[/code] if comment [code]start_key[/code] exists. + + + + + + + + + Returns [code]true[/code] if string [code]start_key[/code] exists. + + + + + + + + + + + Return delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code]. + + + + + + + + + + + Return the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code]. + + @@ -68,6 +292,60 @@ + + + + + + + Removes the comment delimiter with [code]start_key[/code]. + + + + + + + + + Removes the string delimiter with [code]start_key[/code]. + + + + + + + + + Emits [signal request_code_completion], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. + + + + + + + + + Sets the current selected completion option. + + + + + + + + + Sets the code hint text. Pass an empty string to clear. + + + + + + + + + Sets if the code hint should draw below the text. + + @@ -98,8 +376,30 @@ + + + + + + + Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code]. + [b]Note[/b]: This will replace all current candidates. + + + + Sets whether code completion is allowed. + + + Sets prefixes that will trigger code completion. + + + Sets the comment delimiters. All existing comment delimiters will be removed. + + + Sets the string delimiters. All existing string delimiters will be removed. + @@ -123,8 +423,33 @@ + + + Emitted when the user requests code completion. + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 73899daaea5..a200858a3ce 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -703,6 +703,8 @@ + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 29067b55343..74811318dc1 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -128,6 +128,13 @@ Folds the given line, if possible (see [method can_fold]). + + + + + Gets the caret pixel draw poistion. + + @@ -315,6 +322,13 @@ Insert the specified text at the cursor position. + + + + + Returns [code]true[/code] if the caret is visible on the screen. + + @@ -812,10 +826,6 @@ - - - - @@ -964,24 +974,6 @@ - - - - - - - - - - - - - - - - - - Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled.