我的书签
添加书签
移除书签TextEdit
Inherits: Control < CanvasItem < Node < Object
Category: Core
Brief Description
Multiline text editing control.
Properties
Methods
Theme Properties
| Color | background_color |
| Color | brace_mismatch_color |
| Color | breakpoint_color |
| Color | caret_background_color |
| Color | caret_color |
| Color | code_folding_color |
| StyleBox | completion |
| Color | completion_background_color |
| Color | completion_existing_color |
| Color | completion_font_color |
| int | completion_lines |
| int | completion_max_width |
| Color | completion_scroll_color |
| int | completion_scroll_width |
| Color | completion_selected_color |
| Color | current_line_color |
| StyleBox | focus |
| Font | font |
| Color | font_color |
| Color | font_color_selected |
| Color | function_color |
| Color | line_number_color |
| int | line_spacing |
| Color | mark_color |
| Color | member_variable_color |
| StyleBox | normal |
| Color | number_color |
| StyleBox | read_only |
| Color | safe_line_number_color |
| Color | selection_color |
| Color | symbol_color |
| Texture | tab |
| Color | word_highlighted_color |
Signals
- breakpoint_toggled ( 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.
Enumerations
enum SearchFlags:
- 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.
enum MenuItems:
- MENU_CUT = 0 — Cuts (Copies and clears) the selected text.
- MENU_COPY = 1 — Copies the selected text.
- MENU_PASTE = 2 — Pastes the clipboard text over the selected text (or at the cursor’s position).
- MENU_CLEAR = 3 — Erases the whole TextEdit text.
- MENU_SELECT_ALL = 4 — Selects the whole TextEdit text.
- MENU_UNDO = 5 — Undoes the previous action.
- MENU_REDO = 6 — Redoes the previous action.
- MENU_MAX = 7 — Represents the size of the MenuItems enum.
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.
Property Descriptions
- bool breakpoint_gutter
| Setter | set_breakpoint_gutter_enabled(value) |
| Getter | is_breakpoint_gutter_enabled() |
If true, the breakpoint gutter is visible.
- bool caret_blink
| Setter | cursor_set_blink_enabled(value) |
| Getter | cursor_get_blink_enabled() |
If true, the caret (visual cursor) blinks.
- float caret_blink_speed
| Setter | cursor_set_blink_speed(value) |
| Getter | cursor_get_blink_speed() |
Duration (in seconds) of a caret’s blinking cycle.
- bool caret_block_mode
| Setter | cursor_set_block_mode(value) |
| Getter | cursor_is_block_mode() |
If true, the caret displays as a rectangle.
If false, the caret displays as a bar.
- bool caret_moving_by_right_click
| Setter | set_right_click_moves_caret(value) |
| Getter | is_right_click_moving_caret() |
If true, a right click moves the cursor at the mouse position before displaying the context menu.
If false, the context menu disregards mouse location.
- bool context_menu_enabled
| Setter | set_context_menu_enabled(value) |
| Getter | is_context_menu_enabled() |
If true, a right click displays the context menu.
- int hiding_enabled
| Setter | set_hiding_enabled(value) |
| Getter | is_hiding_enabled() |
- bool highlight_all_occurrences
| Setter | set_highlight_all_occurrences(value) |
| Getter | is_highlight_all_occurrences_enabled() |
If true, all occurrences of the selected text will be highlighted.
- bool highlight_current_line
| Setter | set_highlight_current_line(value) |
| Getter | is_highlight_current_line_enabled() |
If true, the line containing the cursor is highlighted.
- bool override_selected_font_color
| Setter | set_override_selected_font_color(value) |
| Getter | is_overriding_selected_font_color() |
- bool readonly
| Setter | set_readonly(value) |
| Getter | is_readonly() |
If true, read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
- bool show_line_numbers
| Setter | set_show_line_numbers(value) |
| Getter | is_show_line_numbers_enabled() |
If true, line numbers are displayed to the left of the text.
- bool smooth_scrolling
| Setter | set_smooth_scroll_enable(value) |
| Getter | is_smooth_scroll_enabled() |
If true, sets the step of the scrollbars to 0.25 which results in smoother scrolling.
- bool syntax_highlighting
| Setter | set_syntax_coloring(value) |
| Getter | is_syntax_coloring_enabled() |
If true, any custom color properties that have been set for this TextEdit will be visible.
- String text
| Setter | set_text(value) |
| Getter | get_text() |
String value of the TextEdit.
- float v_scroll_speed
| Setter | set_v_scroll_speed(value) |
| Getter | get_v_scroll_speed() |
Vertical scroll sensitivity.
- bool wrap_enabled
| Setter | set_wrap_enabled(value) |
| Getter | is_wrap_enabled() |
If true, enables text wrapping when it goes beyond the edge of what is visible.
Method Descriptions
Add color region (given the delimiters) and its colors.
Add a keyword and its Color.
- void clear_colors ( )
Clears all the syntax coloring information.
- void clear_undo_history ( )
Clears the undo history.
- void copy ( )
Copy’s the current text selection.
- int cursor_get_column ( ) const
Returns the column the editing cursor is at.
- int cursor_get_line ( ) const
Returns the line the editing cursor is at.
Moves the cursor at the specified column index.
If adjust_viewport is set to true, the viewport will center at the cursor position after the move occurs. Default value is true.
- void cursor_set_line ( int line, bool adjust_viewport=true, bool can_be_hidden=true, int wrap_index=0 )
Moves the cursor at the specified line index.
If adjust_viewport is set to true, the viewport will center at the cursor position after the move occurs. Default value is true.
If can_be_hidden is set to true, the specified line can be hidden using set_line_as_hidden. Default value is true.
- void cut ( )
Cut’s the current selection.
- void deselect ( )
Deselects the current selection.
- void fold_all_lines ( )
- void fold_line ( int line )
- Array get_breakpoints ( ) const
Returns an array containing the line number of each breakpoint.
Returns the Color of the specified keyword.
Returns the text of a specific line.
- int get_line_count ( ) const
Returns the amount of total lines in the text.
- PopupMenu get_menu ( ) const
- int get_selection_from_column ( ) const
Returns the selection begin column.
- int get_selection_from_line ( ) const
Returns the selection begin line.
- String get_selection_text ( ) const
Returns the text inside the selection.
- int get_selection_to_column ( ) const
Returns the selection end column.
- int get_selection_to_line ( ) const
Returns the selection end line.
- String get_word_under_cursor ( ) const
Returns a String text with the word under the mouse cursor location.
Returns whether the specified keyword has a color set to it or not.
- void insert_text_at_cursor ( String text )
Insert the specified text at the cursor position.
Returns whether the line at the specified index is folded or not.
Returns whether the line at the specified index is hidden or not.
- bool is_selection_active ( ) const
Returns true if the selection is active.
- void menu_option ( int option )
Triggers a right click menu action by the specified index. See MenuItems for a list of available indexes.
- void paste ( )
Paste the current selection.
- void redo ( )
Perform redo operation.
- void remove_breakpoints ( )
Removes all the breakpoints (without firing “breakpoint_toggled” signal).
- PoolIntArray search ( String key, int flags, int from_line, int from_column ) const
Perform a search inside the text. Search flags can be specified in the SEARCH_* enum.
Perform selection, from line/column to line/column.
- void select_all ( )
Select all the text.
If true, hides the line of the specified index.
- void toggle_fold_line ( int line )
Toggle the folding of the code block at the given line.
- void undo ( )
Perform undo operation.
- void unfold_line ( int line )
- void unhide_all_lines ( )
Unhide all lines that were previously set to hidden by set_line_as_hidden.
