classref: Sync with current master branch (f87858a8f)

This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions

View File

@@ -14,107 +14,166 @@ ScriptEditorBase
Base editor for editing scripts in the :ref:`ScriptEditor<class_ScriptEditor>`.
.. rst-class:: classref-introduction-group
Description
-----------
Base editor for editing scripts in the :ref:`ScriptEditor<class_ScriptEditor>`, this does not include documentation items.
.. rst-class:: classref-reftable-group
Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_syntax_highlighter<class_ScriptEditorBase_method_add_syntax_highlighter>` **(** :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` highlighter **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>` | :ref:`get_base_editor<class_ScriptEditorBase_method_get_base_editor>` **(** **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table::
:widths: auto
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_syntax_highlighter<class_ScriptEditorBase_method_add_syntax_highlighter>` **(** :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` highlighter **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>` | :ref:`get_base_editor<class_ScriptEditorBase_method_get_base_editor>` **(** **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_ScriptEditorBase_signal_edited_script_changed:
- **edited_script_changed** **(** **)**
.. rst-class:: classref-signal
**edited_script_changed** **(** **)**
Emitted after script validation.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_go_to_help:
- **go_to_help** **(** :ref:`String<class_String>` what **)**
.. rst-class:: classref-signal
**go_to_help** **(** :ref:`String<class_String>` what **)**
Emitted when the user requests a specific documentation page.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_go_to_method:
- **go_to_method** **(** :ref:`Object<class_Object>` script, :ref:`String<class_String>` method **)**
.. rst-class:: classref-signal
**go_to_method** **(** :ref:`Object<class_Object>` script, :ref:`String<class_String>` method **)**
Emitted when the user requests to view a specific method of a script, similar to :ref:`request_open_script_at_line<class_ScriptEditorBase_signal_request_open_script_at_line>`.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_name_changed:
- **name_changed** **(** **)**
.. rst-class:: classref-signal
**name_changed** **(** **)**
Emitted after script validation or when the edited resource has changed.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_replace_in_files_requested:
- **replace_in_files_requested** **(** :ref:`String<class_String>` text **)**
.. rst-class:: classref-signal
**replace_in_files_requested** **(** :ref:`String<class_String>` text **)**
Emitted when the user request to find and replace text in the file system.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_request_help:
- **request_help** **(** :ref:`String<class_String>` topic **)**
.. rst-class:: classref-signal
**request_help** **(** :ref:`String<class_String>` topic **)**
Emitted when the user requests contextual help.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_request_open_script_at_line:
- **request_open_script_at_line** **(** :ref:`Object<class_Object>` script, :ref:`int<class_int>` line **)**
.. rst-class:: classref-signal
**request_open_script_at_line** **(** :ref:`Object<class_Object>` script, :ref:`int<class_int>` line **)**
Emitted when the user requests to view a specific line of a script, similar to :ref:`go_to_method<class_ScriptEditorBase_signal_go_to_method>`.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_request_save_history:
- **request_save_history** **(** **)**
.. rst-class:: classref-signal
**request_save_history** **(** **)**
Emitted when the user contextual goto and the item is in the same script.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_signal_search_in_files_requested:
- **search_in_files_requested** **(** :ref:`String<class_String>` text **)**
.. rst-class:: classref-signal
**search_in_files_requested** **(** :ref:`String<class_String>` text **)**
Emitted when the user request to search text in the file system.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_ScriptEditorBase_method_add_syntax_highlighter:
- void **add_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` highlighter **)**
.. rst-class:: classref-method
void **add_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` highlighter **)**
Adds a :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` to the open script.
.. rst-class:: classref-item-separator
----
.. _class_ScriptEditorBase_method_get_base_editor:
- :ref:`Control<class_Control>` **get_base_editor** **(** **)** |const|
.. rst-class:: classref-method
:ref:`Control<class_Control>` **get_base_editor** **(** **)** |const|
Returns the underlying :ref:`Control<class_Control>` used for editing scripts. For text scripts, this is a :ref:`CodeEdit<class_CodeEdit>`.