2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 13:57:10 +01:00
<class name= "TextEdit" inherits= "Control" category= "Core" version= "3.0.2" >
2017-09-12 22:42:36 +02: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.
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "add_color_region" >
<return type= "void" >
</return>
<argument index= "0" name= "begin_key" type= "String" >
</argument>
<argument index= "1" name= "end_key" type= "String" >
</argument>
<argument index= "2" name= "color" type= "Color" >
</argument>
<argument index= "3" name= "line_only" type= "bool" default= "false" >
</argument>
<description >
Add color region (given the delimiters) and its colors.
</description>
</method>
<method name= "add_keyword_color" >
<return type= "void" >
</return>
<argument index= "0" name= "keyword" type= "String" >
</argument>
<argument index= "1" name= "color" type= "Color" >
</argument>
<description >
Add a keyword and its color.
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "can_fold" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "clear_colors" >
<return type= "void" >
</return>
<description >
Clear all the syntax coloring information.
</description>
</method>
<method name= "clear_undo_history" >
<return type= "void" >
</return>
<description >
Clear the undo history.
</description>
</method>
<method name= "copy" >
<return type= "void" >
</return>
<description >
Copy the current selection.
</description>
</method>
<method name= "cursor_get_column" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the column the editing cursor is at.
</description>
</method>
<method name= "cursor_get_line" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the line the editing cursor is at.
</description>
</method>
<method name= "cursor_set_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 >
</description>
</method>
<method name= "cursor_set_line" >
<return type= "void" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<argument index= "1" name= "adjust_viewport" type= "bool" default= "true" >
</argument>
2017-11-24 09:16:27 +01:00
<argument index= "2" name= "can_be_hidden" type= "bool" default= "true" >
</argument>
2017-09-12 22:42:36 +02:00
<description >
</description>
</method>
<method name= "cut" >
<return type= "void" >
</return>
<description >
Cut the current selection.
</description>
</method>
2017-12-16 20:34:16 +01:00
<method name= "deselect" >
<return type= "void" >
</return>
<description >
Clears the current selection.
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "fold_all_lines" >
<return type= "void" >
</return>
<description >
</description>
</method>
<method name= "fold_line" >
<return type= "void" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_line" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<description >
Return the text of a specific line.
</description>
</method>
<method name= "get_line_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the amount of total lines in the text.
</description>
</method>
<method name= "get_menu" qualifiers= "const" >
<return type= "PopupMenu" >
</return>
<description >
</description>
</method>
<method name= "get_selection_from_column" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the selection begin column.
</description>
</method>
<method name= "get_selection_from_line" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the selection begin line.
</description>
</method>
<method name= "get_selection_text" qualifiers= "const" >
<return type= "String" >
</return>
<description >
Return the text inside the selection.
</description>
</method>
<method name= "get_selection_to_column" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the selection end column.
</description>
</method>
<method name= "get_selection_to_line" qualifiers= "const" >
<return type= "int" >
</return>
<description >
Return the selection end line.
</description>
</method>
<method name= "get_word_under_cursor" qualifiers= "const" >
<return type= "String" >
</return>
<description >
</description>
</method>
<method name= "insert_text_at_cursor" >
<return type= "void" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
Insert a given text at the cursor position.
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "is_folded" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "is_line_hidden" qualifiers= "const" >
<return type= "bool" >
</return>
2018-01-03 13:45:03 +01:00
<argument index= "0" name= "line" type= "int" >
2017-11-24 09:16:27 +01:00
</argument>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "is_selection_active" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
Return true if the selection is active.
</description>
</method>
<method name= "menu_option" >
<return type= "void" >
</return>
<argument index= "0" name= "option" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "paste" >
<return type= "void" >
</return>
<description >
Paste the current selection.
</description>
</method>
<method name= "redo" >
<return type= "void" >
</return>
<description >
Perform redo operation.
</description>
</method>
<method name= "search" qualifiers= "const" >
<return type= "PoolIntArray" >
</return>
<argument index= "0" name= "key" type= "String" >
</argument>
<argument index= "1" name= "flags" type= "int" >
</argument>
<argument index= "2" name= "from_line" type= "int" >
</argument>
<argument index= "3" name= "from_column" type= "int" >
</argument>
<description >
Perform a search inside the text. Search flags can be specified in the SEARCH_* enum.
</description>
</method>
<method name= "select" >
<return type= "void" >
</return>
<argument index= "0" name= "from_line" type= "int" >
</argument>
<argument index= "1" name= "from_column" type= "int" >
</argument>
<argument index= "2" name= "to_line" type= "int" >
</argument>
<argument index= "3" name= "to_column" type= "int" >
</argument>
<description >
Perform selection, from line/column to line/column.
</description>
</method>
<method name= "select_all" >
<return type= "void" >
</return>
<description >
Select all the text.
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "set_line_as_hidden" >
<return type= "void" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
</description>
</method>
2017-12-10 00:43:30 +01:00
<method name= "toggle_fold_line" >
<return type= "void" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<description >
Toggle the folding of the code block at the given line.
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "undo" >
<return type= "void" >
</return>
<description >
Perform undo operation.
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "unfold_line" >
<return type= "void" >
</return>
<argument index= "0" name= "line" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "unhide_all_lines" >
<return type= "void" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "caret_blink" type= "bool" setter= "cursor_set_blink_enabled" getter= "cursor_get_blink_enabled" >
2017-12-20 02:36:47 +01:00
If [code]true[/code] the caret (visual cursor) blinks.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "caret_blink_speed" type= "float" setter= "cursor_set_blink_speed" getter= "cursor_get_blink_speed" >
2017-12-20 02:36:47 +01:00
Duration (in seconds) of a caret's blinking cycle.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "caret_block_mode" type= "bool" setter= "cursor_set_block_mode" getter= "cursor_is_block_mode" >
2017-12-20 02:36:47 +01:00
If [code]true[/code] the caret displays as a rectangle.
If [code]false[/code] the caret displays as a bar.
</member>
<member name= "caret_moving_by_right_click" type= "bool" setter= "set_right_click_moves_caret" getter= "is_right_click_moving_caret" >
If [code]true[/code] a right click moves the cursor at the mouse position before displaying the context menu.
If [code]false[/code] the context menu disregards mouse location.
2017-09-12 22:42:36 +02:00
</member>
2017-11-13 09:24:36 +01:00
<member name= "context_menu_enabled" type= "bool" setter= "set_context_menu_enabled" getter= "is_context_menu_enabled" >
2017-12-20 02:36:47 +01:00
If [code]true[/code] a right click displays the context menu.
2017-11-13 09:24:36 +01:00
</member>
2017-11-24 09:16:27 +01:00
<member name= "hiding_enabled" type= "int" setter= "set_hiding_enabled" getter= "is_hiding_enabled" >
</member>
2017-09-13 08:49:40 +02:00
<member name= "highlight_all_occurrences" type= "bool" setter= "set_highlight_all_occurrences" getter= "is_highlight_all_occurrences_enabled" >
2017-09-12 22:42:36 +02:00
</member>
2017-10-24 19:22:37 +02:00
<member name= "highlight_current_line" type= "bool" setter= "set_highlight_current_line" getter= "is_highlight_current_line_enabled" >
2017-12-20 02:36:47 +01:00
If [code]true[/code] the line containing the cursor is highlighted.
2017-10-24 19:22:37 +02:00
</member>
2017-10-21 12:02:08 +02:00
<member name= "override_selected_font_color" type= "bool" setter= "set_override_selected_font_color" getter= "is_overriding_selected_font_color" >
</member>
2017-11-13 09:24:36 +01:00
<member name= "readonly" type= "bool" setter= "set_readonly" getter= "is_readonly" >
If [code]true[/code] read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
2017-09-12 22:42:36 +02:00
</member>
2017-11-13 09:24:36 +01:00
<member name= "show_line_numbers" type= "bool" setter= "set_show_line_numbers" getter= "is_show_line_numbers_enabled" >
2017-12-20 02:36:47 +01:00
If [code]true[/code] line numbers are displayed to the left of the text.
2017-11-09 21:46:29 +01:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "smooth_scrolling" type= "bool" setter= "set_smooth_scroll_enable" getter= "is_smooth_scroll_enabled" >
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "syntax_highlighting" type= "bool" setter= "set_syntax_coloring" getter= "is_syntax_coloring_enabled" >
2017-09-12 22:42:36 +02:00
</member>
2017-11-13 09:24:36 +01:00
<member name= "text" type= "String" setter= "set_text" getter= "get_text" >
String value of the [TextEdit].
</member>
2017-09-13 08:49:40 +02:00
<member name= "v_scroll_speed" type= "float" setter= "set_v_scroll_speed" getter= "get_v_scroll_speed" >
2018-01-11 23:38:35 +01:00
If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible.
</member>
<member name= "wrap_lines" type= "bool" setter= "set_wrap" getter= "is_wrapping" >
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals >
<signal name= "breakpoint_toggled" >
<argument index= "0" name= "row" type= "int" >
</argument>
<description >
Emitted when a breakpoint is placed via the breakpoint gutter.
</description>
</signal>
<signal name= "cursor_changed" >
<description >
Emitted when the cursor changes.
</description>
</signal>
<signal name= "request_completion" >
<description >
</description>
</signal>
<signal name= "symbol_lookup" >
<argument index= "0" name= "symbol" type= "String" >
</argument>
<argument index= "1" name= "row" type= "int" >
</argument>
<argument index= "2" name= "column" type= "int" >
</argument>
<description >
</description>
</signal>
<signal name= "text_changed" >
<description >
Emitted when the text changes.
</description>
</signal>
</signals>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "SEARCH_MATCH_CASE" value= "1" enum= "SearchFlags" >
2017-09-12 22:42:36 +02:00
Match case when searching.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "SEARCH_WHOLE_WORDS" value= "2" enum= "SearchFlags" >
2017-09-12 22:42:36 +02:00
Match whole words when searching.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "SEARCH_BACKWARDS" value= "4" enum= "SearchFlags" >
2017-09-12 22:42:36 +02:00
Search from end to beginning.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_CUT" value= "0" enum= "MenuItems" >
2017-12-20 02:36:47 +01:00
Cuts (Copies and clears) the selected text.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_COPY" value= "1" enum= "MenuItems" >
2017-12-20 02:36:47 +01:00
Copies the selected text.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_PASTE" value= "2" enum= "MenuItems" >
2017-12-20 02:36:47 +01:00
Pastes the clipboard text over the selected text (or at the cursor's position).
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_CLEAR" value= "3" enum= "MenuItems" >
2017-12-20 02:36:47 +01:00
Erases the whole [TextEdit] text.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_SELECT_ALL" value= "4" enum= "MenuItems" >
2017-12-20 02:36:47 +01:00
Selects the whole [TextEdit] text.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_UNDO" value= "5" enum= "MenuItems" >
2017-12-20 02:36:47 +01:00
Undoes the previous action.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MENU_MAX" value= "6" enum= "MenuItems" >
2017-09-12 22:42:36 +02:00
</constant>
</constants>
<theme_items >
<theme_item name= "background_color" type= "Color" >
</theme_item>
<theme_item name= "brace_mismatch_color" type= "Color" >
</theme_item>
<theme_item name= "breakpoint_color" type= "Color" >
</theme_item>
<theme_item name= "caret_background_color" type= "Color" >
</theme_item>
<theme_item name= "caret_color" type= "Color" >
</theme_item>
2017-12-10 00:43:30 +01:00
<theme_item name= "code_folding_color" type= "Color" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "completion" type= "StyleBox" >
</theme_item>
<theme_item name= "completion_background_color" type= "Color" >
</theme_item>
<theme_item name= "completion_existing_color" type= "Color" >
</theme_item>
<theme_item name= "completion_font_color" type= "Color" >
</theme_item>
<theme_item name= "completion_lines" type= "int" >
</theme_item>
<theme_item name= "completion_max_width" type= "int" >
</theme_item>
<theme_item name= "completion_scroll_color" type= "Color" >
</theme_item>
<theme_item name= "completion_scroll_width" type= "int" >
</theme_item>
<theme_item name= "completion_selected_color" type= "Color" >
</theme_item>
<theme_item name= "current_line_color" type= "Color" >
</theme_item>
<theme_item name= "focus" type= "StyleBox" >
</theme_item>
<theme_item name= "font" type= "Font" >
</theme_item>
<theme_item name= "font_color" type= "Color" >
</theme_item>
<theme_item name= "font_color_selected" type= "Color" >
</theme_item>
<theme_item name= "function_color" type= "Color" >
</theme_item>
<theme_item name= "line_number_color" type= "Color" >
</theme_item>
<theme_item name= "line_spacing" type= "int" >
</theme_item>
<theme_item name= "mark_color" type= "Color" >
</theme_item>
<theme_item name= "member_variable_color" type= "Color" >
</theme_item>
<theme_item name= "normal" type= "StyleBox" >
</theme_item>
<theme_item name= "number_color" type= "Color" >
</theme_item>
2017-12-07 08:23:08 +01:00
<theme_item name= "read_only" type= "StyleBox" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "selection_color" type= "Color" >
</theme_item>
<theme_item name= "symbol_color" type= "Color" >
</theme_item>
<theme_item name= "tab" type= "Texture" >
</theme_item>
<theme_item name= "word_highlighted_color" type= "Color" >
</theme_item>
</theme_items>
</class>
