godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
2.1
godot-docs/classes/class_textedit.rst
Rémi Verschelde f95738c54a classref: Sync with 2.1 branch, adds signal descriptions
2017-06-17 14:07:36 +02:00

426 lines
33 KiB
ReStructuredText
Raw Permalink Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_TextEdit:
TextEdit
========
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Multiline text editing control.
Member Functions
----------------
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_color_region<class_TextEdit_add_color_region>` **(** :ref:`String<class_string>` begin_key, :ref:`String<class_string>` end_key, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` line_only=false **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_keyword_color<class_TextEdit_add_keyword_color>` **(** :ref:`String<class_string>` keyword, :ref:`Color<class_color>` color **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_colors<class_TextEdit_clear_colors>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_undo_history<class_TextEdit_clear_undo_history>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy<class_TextEdit_copy>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`cursor_get_blink_enabled<class_TextEdit_cursor_get_blink_enabled>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cursor_get_blink_speed<class_TextEdit_cursor_get_blink_speed>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`cursor_get_column<class_TextEdit_cursor_get_column>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`cursor_get_line<class_TextEdit_cursor_get_line>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`cursor_is_block_mode<class_TextEdit_cursor_is_block_mode>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cursor_set_blink_enabled<class_TextEdit_cursor_set_blink_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cursor_set_blink_speed<class_TextEdit_cursor_set_blink_speed>` **(** :ref:`float<class_float>` blink_speed **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cursor_set_block_mode<class_TextEdit_cursor_set_block_mode>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cursor_set_column<class_TextEdit_cursor_set_column>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=false **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cursor_set_line<class_TextEdit_cursor_set_line>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` adjust_viewport=false **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cut<class_TextEdit_cut>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_line<class_TextEdit_get_line>` **(** :ref:`int<class_int>` line **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_count<class_TextEdit_get_line_count>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_popupmenu>` | :ref:`get_menu<class_TextEdit_get_menu>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selection_from_column<class_TextEdit_get_selection_from_column>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selection_from_line<class_TextEdit_get_selection_from_line>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_selection_text<class_TextEdit_get_selection_text>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selection_to_column<class_TextEdit_get_selection_to_column>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selection_to_line<class_TextEdit_get_selection_to_line>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_TextEdit_get_text>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_word_under_cursor<class_TextEdit_get_word_under_cursor>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`insert_text_at_cursor<class_TextEdit_insert_text_at_cursor>` **(** :ref:`String<class_string>` text **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_highlight_all_occurrences_enabled<class_TextEdit_is_highlight_all_occurrences_enabled>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selection_active<class_TextEdit_is_selection_active>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_show_line_numbers_enabled<class_TextEdit_is_show_line_numbers_enabled>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_syntax_coloring_enabled<class_TextEdit_is_syntax_coloring_enabled>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`menu_option<class_TextEdit_menu_option>` **(** :ref:`int<class_int>` arg0 **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`paste<class_TextEdit_paste>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`redo<class_TextEdit_redo>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`search<class_TextEdit_search>` **(** :ref:`String<class_string>` flags, :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_TextEdit_select>` **(** :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line, :ref:`int<class_int>` to_column **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select_all<class_TextEdit_select_all>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_bg_color<class_TextEdit_set_custom_bg_color>` **(** :ref:`Color<class_color>` color **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_highlight_all_occurrences<class_TextEdit_set_highlight_all_occurrences>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max_chars<class_TextEdit_set_max_chars>` **(** :ref:`int<class_int>` amount **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_readonly<class_TextEdit_set_readonly>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_show_line_numbers<class_TextEdit_set_show_line_numbers>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_symbol_color<class_TextEdit_set_symbol_color>` **(** :ref:`Color<class_color>` color **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_syntax_coloring<class_TextEdit_set_syntax_coloring>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_TextEdit_set_text>` **(** :ref:`String<class_string>` text **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_wrap<class_TextEdit_set_wrap>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`undo<class_TextEdit_undo>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **breakpoint_toggled** **(** :ref:`int<class_int>` row **)**
Emitted when a breakpoint is placed via the breakpoint gutter.
- **cursor_changed** **(** **)**
Emitted when the cursor changes.
- **request_completion** **(** **)**
- **text_changed** **(** **)**
Emitted when the text changes.
Numeric Constants
-----------------
- **SEARCH_MATCH_CASE** = **1** --- Match case when searching.
- **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching.
- **SEARCH_BACKWARDS** = **4** --- Search from end to beginning.
- **MENU_CUT** = **0**
- **MENU_COPY** = **1**
- **MENU_PASTE** = **2**
- **MENU_CLEAR** = **3**
- **MENU_SELECT_ALL** = **4**
- **MENU_UNDO** = **5**
- **MENU_MAX** = **6**
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.
Member Function Description
---------------------------
.. _class_TextEdit_add_color_region:
- void **add_color_region** **(** :ref:`String<class_string>` begin_key, :ref:`String<class_string>` end_key, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` line_only=false **)**
Add color region (given the delimiters) and its colors.
.. _class_TextEdit_add_keyword_color:
- void **add_keyword_color** **(** :ref:`String<class_string>` keyword, :ref:`Color<class_color>` color **)**
Add a keyword and its color.
.. _class_TextEdit_clear_colors:
- void **clear_colors** **(** **)**
Clear all the syntax coloring information.
.. _class_TextEdit_clear_undo_history:
- void **clear_undo_history** **(** **)**
Clear the undo history.
.. _class_TextEdit_copy:
- void **copy** **(** **)**
Copy the current selection.
.. _class_TextEdit_cursor_get_blink_enabled:
- :ref:`bool<class_bool>` **cursor_get_blink_enabled** **(** **)** const
Gets whether the text editor caret is blinking.
.. _class_TextEdit_cursor_get_blink_speed:
- :ref:`float<class_float>` **cursor_get_blink_speed** **(** **)** const
Gets the text editor caret blink speed.
.. _class_TextEdit_cursor_get_column:
- :ref:`int<class_int>` **cursor_get_column** **(** **)** const
Return the column the editing cursor is at.
.. _class_TextEdit_cursor_get_line:
- :ref:`int<class_int>` **cursor_get_line** **(** **)** const
Return the line the editing cursor is at.
.. _class_TextEdit_cursor_is_block_mode:
- :ref:`bool<class_bool>` **cursor_is_block_mode** **(** **)** const
Gets whether the text editor caret is in block mode.
.. _class_TextEdit_cursor_set_blink_enabled:
- void **cursor_set_blink_enabled** **(** :ref:`bool<class_bool>` enable **)**
Set the text editor caret to blink.
.. _class_TextEdit_cursor_set_blink_speed:
- void **cursor_set_blink_speed** **(** :ref:`float<class_float>` blink_speed **)**
Set the text editor caret blink speed. Cannot be less then or equal to 0.
.. _class_TextEdit_cursor_set_block_mode:
- void **cursor_set_block_mode** **(** :ref:`bool<class_bool>` enable **)**
Set the text editor caret to block mode.
.. _class_TextEdit_cursor_set_column:
- void **cursor_set_column** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=false **)**
.. _class_TextEdit_cursor_set_line:
- void **cursor_set_line** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` adjust_viewport=false **)**
.. _class_TextEdit_cut:
- void **cut** **(** **)**
Cut the current selection.
.. _class_TextEdit_get_line:
- :ref:`String<class_string>` **get_line** **(** :ref:`int<class_int>` line **)** const
Return the text of a specific line.
.. _class_TextEdit_get_line_count:
- :ref:`int<class_int>` **get_line_count** **(** **)** const
Return the amount of total lines in the text.
.. _class_TextEdit_get_menu:
- :ref:`PopupMenu<class_popupmenu>` **get_menu** **(** **)** const
.. _class_TextEdit_get_selection_from_column:
- :ref:`int<class_int>` **get_selection_from_column** **(** **)** const
Return the selection begin column.
.. _class_TextEdit_get_selection_from_line:
- :ref:`int<class_int>` **get_selection_from_line** **(** **)** const
Return the selection begin line.
.. _class_TextEdit_get_selection_text:
- :ref:`String<class_string>` **get_selection_text** **(** **)** const
Return the text inside the selection.
.. _class_TextEdit_get_selection_to_column:
- :ref:`int<class_int>` **get_selection_to_column** **(** **)** const
Return the selection end column.
.. _class_TextEdit_get_selection_to_line:
- :ref:`int<class_int>` **get_selection_to_line** **(** **)** const
Return the selection end line.
.. _class_TextEdit_get_text:
- :ref:`String<class_string>` **get_text** **(** **)**
Return the whole text.
.. _class_TextEdit_get_word_under_cursor:
- :ref:`String<class_string>` **get_word_under_cursor** **(** **)** const
.. _class_TextEdit_insert_text_at_cursor:
- void **insert_text_at_cursor** **(** :ref:`String<class_string>` text **)**
Insert a given text at the cursor position.
.. _class_TextEdit_is_highlight_all_occurrences_enabled:
- :ref:`bool<class_bool>` **is_highlight_all_occurrences_enabled** **(** **)** const
Returns true if highlight all occurrences is enabled.
.. _class_TextEdit_is_selection_active:
- :ref:`bool<class_bool>` **is_selection_active** **(** **)** const
Return true if the selection is active.
.. _class_TextEdit_is_show_line_numbers_enabled:
- :ref:`bool<class_bool>` **is_show_line_numbers_enabled** **(** **)** const
Returns true if line numbers are enabled.
.. _class_TextEdit_is_syntax_coloring_enabled:
- :ref:`bool<class_bool>` **is_syntax_coloring_enabled** **(** **)** const
Return true if the syntax coloring is enabled.
.. _class_TextEdit_menu_option:
- void **menu_option** **(** :ref:`int<class_int>` arg0 **)**
.. _class_TextEdit_paste:
- void **paste** **(** **)**
Paste the current selection.
.. _class_TextEdit_redo:
- void **redo** **(** **)**
Perform redo operation.
.. _class_TextEdit_search:
- :ref:`IntArray<class_intarray>` **search** **(** :ref:`String<class_string>` flags, :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line **)** const
Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum.
.. _class_TextEdit_select:
- void **select** **(** :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line, :ref:`int<class_int>` to_column **)**
Perform selection, from line/column to line/column.
.. _class_TextEdit_select_all:
- void **select_all** **(** **)**
Select all the text.
.. _class_TextEdit_set_custom_bg_color:
- void **set_custom_bg_color** **(** :ref:`Color<class_color>` color **)**
Set a custom background color. A background color with alpha==0 disables this.
.. _class_TextEdit_set_highlight_all_occurrences:
- void **set_highlight_all_occurrences** **(** :ref:`bool<class_bool>` enable **)**
Set to enable highlighting all occurrences of the current selection.
.. _class_TextEdit_set_max_chars:
- void **set_max_chars** **(** :ref:`int<class_int>` amount **)**
Set the maximum amount of characters editable.
.. _class_TextEdit_set_readonly:
- void **set_readonly** **(** :ref:`bool<class_bool>` enable **)**
Set the text editor as read-only. Text can be displayed but not edited.
.. _class_TextEdit_set_show_line_numbers:
- void **set_show_line_numbers** **(** :ref:`bool<class_bool>` enable **)**
Set to enable showing line numbers.
.. _class_TextEdit_set_symbol_color:
- void **set_symbol_color** **(** :ref:`Color<class_color>` color **)**
Set the color for symbols.
.. _class_TextEdit_set_syntax_coloring:
- void **set_syntax_coloring** **(** :ref:`bool<class_bool>` enable **)**
Set to enable the syntax coloring.
.. _class_TextEdit_set_text:
- void **set_text** **(** :ref:`String<class_string>` text **)**
Set the entire text.
.. _class_TextEdit_set_wrap:
- void **set_wrap** **(** :ref:`bool<class_bool>` enable **)**
Enable text wrapping when it goes beyond he edge of what is visible.
.. _class_TextEdit_undo:
- void **undo** **(** **)**
Perform undo operation.
Reference in New Issue View Git Blame Copy Permalink