diff options
Diffstat (limited to 'doc/classes/TextEdit.xml')
| -rw-r--r-- | doc/classes/TextEdit.xml | 55 |
1 files changed, 40 insertions, 15 deletions
diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index b2e3885ff2..0210815d75 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextEdit" inherits="Control" category="Core" version="3.1"> +<class name="TextEdit" inherits="Control" category="Core" version="3.2"> <brief_description> Multiline text editing control. </brief_description> @@ -8,8 +8,6 @@ </description> <tutorials> </tutorials> - <demos> - </demos> <methods> <method name="add_color_region"> <return type="void"> @@ -43,6 +41,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Returns if the given line is foldable, that is, it has indented lines right below it. </description> </method> <method name="clear_colors"> @@ -122,6 +121,7 @@ <return type="void"> </return> <description> + Folds all lines that are possible to be folded (see [method can_fold]). </description> </method> <method name="fold_line"> @@ -130,6 +130,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Folds the given line, if possible (see [method can_fold]). </description> </method> <method name="get_breakpoints" qualifiers="const"> @@ -167,6 +168,7 @@ <return type="PopupMenu"> </return> <description> + Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. </description> </method> <method name="get_selection_from_column" qualifiers="const"> @@ -233,6 +235,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Returns if the given line is folded. </description> </method> <method name="is_line_hidden" qualifiers="const"> @@ -247,7 +250,7 @@ <return type="bool"> </return> <description> - Return true if the selection is active. + Return [code]true[/code] if the selection is active. </description> </method> <method name="menu_option"> @@ -348,6 +351,7 @@ <argument index="0" name="line" type="int"> </argument> <description> + Unfolds the given line, if folded. </description> </method> <method name="unhide_all_lines"> @@ -359,39 +363,45 @@ </methods> <members> <member name="breakpoint_gutter" type="bool" setter="set_breakpoint_gutter_enabled" getter="is_breakpoint_gutter_enabled"> - If [code]true[/code] the breakpoint gutter is visible. + If [code]true[/code], the breakpoint gutter is visible. </member> <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled"> - If [code]true[/code] the caret (visual cursor) blinks. + If [code]true[/code], the caret (visual cursor) blinks. </member> <member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed"> Duration (in seconds) of a caret's blinking cycle. </member> <member name="caret_block_mode" type="bool" setter="cursor_set_block_mode" getter="cursor_is_block_mode"> - If [code]true[/code] the caret displays as a rectangle. - If [code]false[/code] the caret displays as a bar. + 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. + 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. </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> - If [code]true[/code] a right click displays the context menu. + If [code]true[/code], a right click displays the context menu. + </member> + <member name="draw_tabs" type="bool" setter="set_draw_tabs" getter="is_drawing_tabs"> + If [code]true[/code], the "tab" character will have a visible representation. + </member> + <member name="fold_gutter" type="bool" setter="set_fold_gutter_enabled" getter="is_fold_gutter_enabled"> + If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines. </member> <member name="hiding_enabled" type="int" setter="set_hiding_enabled" getter="is_hiding_enabled"> </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> </member> <member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled"> - If [code]true[/code] the line containing the cursor is highlighted. + If [code]true[/code], the line containing the cursor is highlighted. </member> <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> </member> <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. + If [code]true[/code], read-only mode is enabled. Existing text cannot be modified and new text cannot be added. </member> <member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled"> - If [code]true[/code] line numbers are displayed to the left of the text. + If [code]true[/code], line numbers are displayed to the left of the text. </member> <member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled"> </member> @@ -401,9 +411,10 @@ String value of the [TextEdit]. </member> <member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed"> - If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible. + Vertical scroll sensitivity. </member> <member name="wrap_enabled" type="bool" setter="set_wrap_enabled" getter="is_wrap_enabled"> + If [code]true[/code], enables text wrapping when it goes beyond the edge of what is visible. </member> </members> <signals> @@ -419,6 +430,14 @@ Emitted when the cursor changes. </description> </signal> + <signal name="info_clicked"> + <argument index="0" name="row" type="int"> + </argument> + <argument index="1" name="info" type="String"> + </argument> + <description> + </description> + </signal> <signal name="request_completion"> <description> </description> @@ -505,8 +524,14 @@ </theme_item> <theme_item name="current_line_color" type="Color"> </theme_item> + <theme_item name="executing_line_color" type="Color"> + </theme_item> <theme_item name="focus" type="StyleBox"> </theme_item> + <theme_item name="fold" type="Texture"> + </theme_item> + <theme_item name="folded" type="Texture"> + </theme_item> <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> |