TextEdit

Inherits: Control < CanvasItem < Node < Object

Inherited By: CodeEdit

There is currently no description for this class. Please help us by contributing one!

Properties

AutowrapMode	autowrap_mode	`3`
bool	caret_blink	`false`
float	caret_blink_interval	`0.65`
bool	caret_draw_when_editable_disabled	`false`
bool	caret_mid_grapheme	`false`
bool	caret_move_on_right_click	`true`
bool	caret_multiple	`true`
CaretType	caret_type	`0`
bool	clip_contents	`true` (overrides Control)
bool	context_menu_enabled	`true`
String	custom_word_separators	`""`
bool	deselect_on_focus_loss_enabled	`true`
bool	drag_and_drop_selection_enabled	`true`
bool	draw_control_chars	`false`
bool	draw_spaces	`false`
bool	draw_tabs	`false`
bool	editable	`true`
FocusMode	focus_mode	`2` (overrides Control)
bool	highlight_all_occurrences	`false`
bool	highlight_current_line	`false`
bool	indent_wrapped_lines	`false`
String	language	`""`
bool	middle_mouse_paste_enabled	`true`
bool	minimap_draw	`false`
int	minimap_width	`80`
CursorShape	mouse_default_cursor_shape	`1` (overrides Control)
String	placeholder_text	`""`
bool	scroll_fit_content_height	`false`
int	scroll_horizontal	`0`
bool	scroll_past_end_of_file	`false`
bool	scroll_smooth	`false`
float	scroll_v_scroll_speed	`80.0`
float	scroll_vertical	`0.0`
bool	selecting_enabled	`true`
bool	shortcut_keys_enabled	`true`
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
SyntaxHighlighter	syntax_highlighter
String	text	`""`
TextDirection	text_direction	`0`
bool	use_custom_word_separators	`false`
bool	use_default_word_separators	`true`
bool	virtual_keyboard_enabled	`true`
LineWrappingMode	wrap_mode	`0`

Methods

void	_backspace ( int caret_index ) virtual
void	_copy ( int caret_index ) virtual
void	_cut ( int caret_index ) virtual
void	_handle_unicode_input ( int unicode_char, int caret_index ) virtual
void	_paste ( int caret_index ) virtual
void	_paste_primary_clipboard ( int caret_index ) virtual
int	add_caret ( int line, int column )
void	add_caret_at_carets ( bool below )
void	add_gutter ( int at=-1 )
void	add_selection_for_next_occurrence ( )
void	adjust_carets_after_edit ( int caret, int from_line, int from_col, int to_line, int to_col )
void	adjust_viewport_to_caret ( int caret_index=0 )
void	apply_ime ( )
void	backspace ( int caret_index=-1 )
void	begin_complex_operation ( )
void	begin_multicaret_edit ( )
void	cancel_ime ( )
void	center_viewport_to_caret ( int caret_index=0 )
void	clear ( )
void	clear_undo_history ( )
void	collapse_carets ( int from_line, int from_column, int to_line, int to_column, bool inclusive=false )
void	copy ( int caret_index=-1 )
void	cut ( int caret_index=-1 )
void	delete_selection ( int caret_index=-1 )
void	deselect ( int caret_index=-1 )
void	end_action ( )
void	end_complex_operation ( )
void	end_multicaret_edit ( )
int	get_caret_column ( int caret_index=0 ) const
int	get_caret_count ( ) const
Vector2	get_caret_draw_pos ( int caret_index=0 ) const
PackedInt32Array	get_caret_index_edit_order ( )
int	get_caret_line ( int caret_index=0 ) const
int	get_caret_wrap_index ( int caret_index=0 ) const
int	get_first_non_whitespace_column ( int line ) const
int	get_first_visible_line ( ) const
int	get_gutter_count ( ) const
String	get_gutter_name ( int gutter ) const
GutterType	get_gutter_type ( int gutter ) const
int	get_gutter_width ( int gutter ) const
HScrollBar	get_h_scroll_bar ( ) const
int	get_indent_level ( int line ) const
int	get_last_full_visible_line ( ) const
int	get_last_full_visible_line_wrap_index ( ) const
int	get_last_unhidden_line ( ) const
String	get_line ( int line ) const
Color	get_line_background_color ( int line ) const
Vector2i	get_line_column_at_pos ( Vector2i position, bool allow_out_of_bounds=true ) const
int	get_line_count ( ) const
Texture2D	get_line_gutter_icon ( int line, int gutter ) const
Color	get_line_gutter_item_color ( int line, int gutter ) const
Variant	get_line_gutter_metadata ( int line, int gutter ) const
String	get_line_gutter_text ( int line, int gutter ) const
int	get_line_height ( ) const
Vector2i[]	get_line_ranges_from_carets ( bool only_selections=false, bool merge_adjacent=true ) const
int	get_line_width ( int line, int wrap_index=-1 ) const
int	get_line_wrap_count ( int line ) const
int	get_line_wrap_index_at_column ( int line, int column ) const
PackedStringArray	get_line_wrapped_text ( int line ) const
Vector2	get_local_mouse_pos ( ) const
PopupMenu	get_menu ( ) const
int	get_minimap_line_at_pos ( Vector2i position ) const
int	get_minimap_visible_lines ( ) const
Vector2i	get_next_visible_line_index_offset_from ( int line, int wrap_index, int visible_amount ) const
int	get_next_visible_line_offset_from ( int line, int visible_amount ) const
Vector2i	get_pos_at_line_column ( int line, int column ) const
Rect2i	get_rect_at_line_column ( int line, int column ) const
int	get_saved_version ( ) const
float	get_scroll_pos_for_line ( int line, int wrap_index=0 ) const
String	get_selected_text ( int caret_index=-1 )
int	get_selection_at_line_column ( int line, int column, bool include_edges=true, bool only_selections=true ) const
int	get_selection_column ( int caret_index=0 ) const
int	get_selection_from_column ( int caret_index=0 ) const
int	get_selection_from_line ( int caret_index=0 ) const
int	get_selection_line ( int caret_index=0 ) const
SelectionMode	get_selection_mode ( ) const
int	get_selection_origin_column ( int caret_index=0 ) const
int	get_selection_origin_line ( int caret_index=0 ) const
int	get_selection_to_column ( int caret_index=0 ) const
int	get_selection_to_line ( int caret_index=0 ) const
PackedInt32Array	get_sorted_carets ( bool include_ignored_carets=false ) const
int	get_tab_size ( ) const
int	get_total_gutter_width ( ) const
int	get_total_visible_line_count ( ) const
VScrollBar	get_v_scroll_bar ( ) const
int	get_version ( ) const
int	get_visible_line_count ( ) const
int	get_visible_line_count_in_range ( int from_line, int to_line ) const
String	get_word_at_pos ( Vector2 position ) const
String	get_word_under_caret ( int caret_index=-1 ) const
bool	has_ime_text ( ) const
bool	has_redo ( ) const
bool	has_selection ( int caret_index=-1 ) const
bool	has_undo ( ) const
void	insert_line_at ( int line, String text )
void	insert_text ( String text, int line, int column, bool before_selection_begin=true, bool before_selection_end=false )
void	insert_text_at_caret ( String text, int caret_index=-1 )
bool	is_caret_after_selection_origin ( int caret_index=0 ) const
bool	is_caret_visible ( int caret_index=0 ) const
bool	is_dragging_cursor ( ) const
bool	is_gutter_clickable ( int gutter ) const
bool	is_gutter_drawn ( int gutter ) const
bool	is_gutter_overwritable ( int gutter ) const
bool	is_in_mulitcaret_edit ( ) const
bool	is_line_gutter_clickable ( int line, int gutter ) const
bool	is_line_wrapped ( int line ) const
bool	is_menu_visible ( ) const
bool	is_mouse_over_selection ( bool edges, int caret_index=-1 ) const
bool	is_overtype_mode_enabled ( ) const
void	menu_option ( int option )
void	merge_gutters ( int from_line, int to_line )
void	merge_overlapping_carets ( )
bool	multicaret_edit_ignore_caret ( int caret_index ) const
void	paste ( int caret_index=-1 )
void	paste_primary_clipboard ( int caret_index=-1 )
void	redo ( )
void	remove_caret ( int caret )
void	remove_gutter ( int gutter )
void	remove_line_at ( int line, bool move_carets_down=true )
void	remove_secondary_carets ( )
void	remove_text ( int from_line, int from_column, int to_line, int to_column )
Vector2i	search ( String text, int flags, int from_line, int from_column ) const
void	select ( int origin_line, int origin_column, int caret_line, int caret_column, int caret_index=0 )
void	select_all ( )
void	select_word_under_caret ( int caret_index=-1 )
void	set_caret_column ( int column, bool adjust_viewport=true, int caret_index=0 )
void	set_caret_line ( int line, bool adjust_viewport=true, bool can_be_hidden=true, int wrap_index=0, int caret_index=0 )
void	set_gutter_clickable ( int gutter, bool clickable )
void	set_gutter_custom_draw ( int column, Callable draw_callback )
void	set_gutter_draw ( int gutter, bool draw )
void	set_gutter_name ( int gutter, String name )
void	set_gutter_overwritable ( int gutter, bool overwritable )
void	set_gutter_type ( int gutter, GutterType type )
void	set_gutter_width ( int gutter, int width )
void	set_line ( int line, String new_text )
void	set_line_as_center_visible ( int line, int wrap_index=0 )
void	set_line_as_first_visible ( int line, int wrap_index=0 )
void	set_line_as_last_visible ( int line, int wrap_index=0 )
void	set_line_background_color ( int line, Color color )
void	set_line_gutter_clickable ( int line, int gutter, bool clickable )
void	set_line_gutter_icon ( int line, int gutter, Texture2D icon )
void	set_line_gutter_item_color ( int line, int gutter, Color color )
void	set_line_gutter_metadata ( int line, int gutter, Variant metadata )
void	set_line_gutter_text ( int line, int gutter, String text )
void	set_overtype_mode_enabled ( bool enabled )
void	set_search_flags ( int flags )
void	set_search_text ( String search_text )
void	set_selection_mode ( SelectionMode mode )
void	set_selection_origin_column ( int column, int caret_index=0 )
void	set_selection_origin_line ( int line, bool can_be_hidden=true, int wrap_index=-1, int caret_index=0 )
void	set_tab_size ( int size )
void	set_tooltip_request_func ( Callable callback )
void	skip_selection_for_next_occurrence ( )
void	start_action ( EditAction action )
void	swap_lines ( int from_line, int to_line )
void	tag_saved_version ( )
void	undo ( )

Theme Properties

Color	background_color	`Color(0, 0, 0, 0)`
Color	caret_background_color	`Color(0, 0, 0, 1)`
Color	caret_color	`Color(0.875, 0.875, 0.875, 1)`
Color	current_line_color	`Color(0.25, 0.25, 0.26, 0.8)`
Color	font_color	`Color(0.875, 0.875, 0.875, 1)`
Color	font_outline_color	`Color(0, 0, 0, 1)`
Color	font_placeholder_color	`Color(0.875, 0.875, 0.875, 0.6)`
Color	font_readonly_color	`Color(0.875, 0.875, 0.875, 0.5)`
Color	font_selected_color	`Color(0, 0, 0, 0)`
Color	search_result_border_color	`Color(0.3, 0.3, 0.3, 0.4)`
Color	search_result_color	`Color(0.3, 0.3, 0.3, 1)`
Color	selection_color	`Color(0.5, 0.5, 0.5, 1)`
Color	word_highlighted_color	`Color(0.5, 0.5, 0.5, 0.25)`
int	caret_width	`1`
int	line_spacing	`4`
int	outline_size	`0`
Font	font
int	font_size
Texture2D	space
Texture2D	tab
StyleBox	focus
StyleBox	normal
StyleBox	read_only

Signals

caret_changed ( )

There is currently no description for this signal. Please help us by contributing one!

gutter_added ( )

There is currently no description for this signal. Please help us by contributing one!

gutter_clicked ( int line, int gutter )

There is currently no description for this signal. Please help us by contributing one!

gutter_removed ( )

There is currently no description for this signal. Please help us by contributing one!

lines_edited_from ( int from_line, int to_line )

There is currently no description for this signal. Please help us by contributing one!

text_changed ( )

There is currently no description for this signal. Please help us by contributing one!

text_set ( )

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum MenuItems:

MenuItems MENU_CUT = 0

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_COPY = 1

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_PASTE = 2

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_CLEAR = 3

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_SELECT_ALL = 4

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_UNDO = 5

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_REDO = 6

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_SUBMENU_TEXT_DIR = 7

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_DIR_INHERITED = 8

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_DIR_AUTO = 9

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_DIR_LTR = 10

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_DIR_RTL = 11

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_DISPLAY_UCC = 12

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_SUBMENU_INSERT_UCC = 13

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_LRM = 14

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_RLM = 15

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_LRE = 16

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_RLE = 17

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_LRO = 18

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_RLO = 19

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_PDF = 20

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_ALM = 21

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_LRI = 22

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_RLI = 23

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_FSI = 24

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_PDI = 25

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_ZWJ = 26

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_ZWNJ = 27

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_WJ = 28

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_INSERT_SHY = 29

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_MAX = 30

There is currently no description for this enum. Please help us by contributing one!

enum EditAction:

EditAction ACTION_NONE = 0

There is currently no description for this enum. Please help us by contributing one!

EditAction ACTION_TYPING = 1

There is currently no description for this enum. Please help us by contributing one!

EditAction ACTION_BACKSPACE = 2

There is currently no description for this enum. Please help us by contributing one!

EditAction ACTION_DELETE = 3

There is currently no description for this enum. Please help us by contributing one!

enum SearchFlags:

SearchFlags SEARCH_MATCH_CASE = 1

There is currently no description for this enum. Please help us by contributing one!

SearchFlags SEARCH_WHOLE_WORDS = 2

There is currently no description for this enum. Please help us by contributing one!

SearchFlags SEARCH_BACKWARDS = 4

There is currently no description for this enum. Please help us by contributing one!

enum CaretType:

CaretType CARET_TYPE_LINE = 0

There is currently no description for this enum. Please help us by contributing one!

CaretType CARET_TYPE_BLOCK = 1

There is currently no description for this enum. Please help us by contributing one!

enum SelectionMode:

SelectionMode SELECTION_MODE_NONE = 0

There is currently no description for this enum. Please help us by contributing one!

SelectionMode SELECTION_MODE_SHIFT = 1

There is currently no description for this enum. Please help us by contributing one!

SelectionMode SELECTION_MODE_POINTER = 2

There is currently no description for this enum. Please help us by contributing one!

SelectionMode SELECTION_MODE_WORD = 3

There is currently no description for this enum. Please help us by contributing one!

SelectionMode SELECTION_MODE_LINE = 4

There is currently no description for this enum. Please help us by contributing one!

enum LineWrappingMode:

LineWrappingMode LINE_WRAPPING_NONE = 0

There is currently no description for this enum. Please help us by contributing one!

LineWrappingMode LINE_WRAPPING_BOUNDARY = 1

There is currently no description for this enum. Please help us by contributing one!

enum GutterType:

GutterType GUTTER_TYPE_STRING = 0

There is currently no description for this enum. Please help us by contributing one!

GutterType GUTTER_TYPE_ICON = 1

There is currently no description for this enum. Please help us by contributing one!

GutterType GUTTER_TYPE_CUSTOM = 2

There is currently no description for this enum. Please help us by contributing one!

Property Descriptions

AutowrapMode autowrap_mode = 3

void set_autowrap_mode ( AutowrapMode value )
AutowrapMode get_autowrap_mode ( )

There is currently no description for this property. Please help us by contributing one!

bool caret_blink = false

void set_caret_blink_enabled ( bool value )
bool is_caret_blink_enabled ( )

There is currently no description for this property. Please help us by contributing one!

float caret_blink_interval = 0.65

void set_caret_blink_interval ( float value )
float get_caret_blink_interval ( )

There is currently no description for this property. Please help us by contributing one!

bool caret_draw_when_editable_disabled = false

void set_draw_caret_when_editable_disabled ( bool value )
bool is_drawing_caret_when_editable_disabled ( )

There is currently no description for this property. Please help us by contributing one!

bool caret_mid_grapheme = false

void set_caret_mid_grapheme_enabled ( bool value )
bool is_caret_mid_grapheme_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool caret_move_on_right_click = true

void set_move_caret_on_right_click_enabled ( bool value )
bool is_move_caret_on_right_click_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool caret_multiple = true

void set_multiple_carets_enabled ( bool value )
bool is_multiple_carets_enabled ( )

There is currently no description for this property. Please help us by contributing one!

CaretType caret_type = 0

void set_caret_type ( CaretType value )
CaretType get_caret_type ( )

There is currently no description for this property. Please help us by contributing one!

bool context_menu_enabled = true

void set_context_menu_enabled ( bool value )
bool is_context_menu_enabled ( )

There is currently no description for this property. Please help us by contributing one!

String custom_word_separators = ""

void set_custom_word_separators ( String value )
String get_custom_word_separators ( )

There is currently no description for this property. Please help us by contributing one!

bool deselect_on_focus_loss_enabled = true

void set_deselect_on_focus_loss_enabled ( bool value )
bool is_deselect_on_focus_loss_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool drag_and_drop_selection_enabled = true

void set_drag_and_drop_selection_enabled ( bool value )
bool is_drag_and_drop_selection_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool draw_control_chars = false

void set_draw_control_chars ( bool value )
bool get_draw_control_chars ( )

There is currently no description for this property. Please help us by contributing one!

bool draw_spaces = false

void set_draw_spaces ( bool value )
bool is_drawing_spaces ( )

There is currently no description for this property. Please help us by contributing one!

bool draw_tabs = false

void set_draw_tabs ( bool value )
bool is_drawing_tabs ( )

There is currently no description for this property. Please help us by contributing one!

bool editable = true

void set_editable ( bool value )
bool is_editable ( )

There is currently no description for this property. Please help us by contributing one!

bool highlight_all_occurrences = false

void set_highlight_all_occurrences ( bool value )
bool is_highlight_all_occurrences_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool highlight_current_line = false

void set_highlight_current_line ( bool value )
bool is_highlight_current_line_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool indent_wrapped_lines = false

void set_indent_wrapped_lines ( bool value )
bool is_indent_wrapped_lines ( )

There is currently no description for this property. Please help us by contributing one!

String language = ""

void set_language ( String value )
String get_language ( )

There is currently no description for this property. Please help us by contributing one!

bool middle_mouse_paste_enabled = true

void set_middle_mouse_paste_enabled ( bool value )
bool is_middle_mouse_paste_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool minimap_draw = false

void set_draw_minimap ( bool value )
bool is_drawing_minimap ( )

There is currently no description for this property. Please help us by contributing one!

int minimap_width = 80

void set_minimap_width ( int value )
int get_minimap_width ( )

There is currently no description for this property. Please help us by contributing one!

String placeholder_text = ""

void set_placeholder ( String value )
String get_placeholder ( )

There is currently no description for this property. Please help us by contributing one!

bool scroll_fit_content_height = false

void set_fit_content_height_enabled ( bool value )
bool is_fit_content_height_enabled ( )

There is currently no description for this property. Please help us by contributing one!

int scroll_horizontal = 0

void set_h_scroll ( int value )
int get_h_scroll ( )

There is currently no description for this property. Please help us by contributing one!

bool scroll_past_end_of_file = false

void set_scroll_past_end_of_file_enabled ( bool value )
bool is_scroll_past_end_of_file_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool scroll_smooth = false

void set_smooth_scroll_enabled ( bool value )
bool is_smooth_scroll_enabled ( )

There is currently no description for this property. Please help us by contributing one!

float scroll_v_scroll_speed = 80.0

void set_v_scroll_speed ( float value )
float get_v_scroll_speed ( )

There is currently no description for this property. Please help us by contributing one!

float scroll_vertical = 0.0

void set_v_scroll ( float value )
float get_v_scroll ( )

There is currently no description for this property. Please help us by contributing one!

bool selecting_enabled = true

void set_selecting_enabled ( bool value )
bool is_selecting_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool shortcut_keys_enabled = true

void set_shortcut_keys_enabled ( bool value )
bool is_shortcut_keys_enabled ( )

There is currently no description for this property. Please help us by contributing one!

StructuredTextParser structured_text_bidi_override = 0

void set_structured_text_bidi_override ( StructuredTextParser value )
StructuredTextParser get_structured_text_bidi_override ( )

There is currently no description for this property. Please help us by contributing one!

Array structured_text_bidi_override_options = []

void set_structured_text_bidi_override_options ( Array value )
Array get_structured_text_bidi_override_options ( )

There is currently no description for this property. Please help us by contributing one!

SyntaxHighlighter syntax_highlighter

void set_syntax_highlighter ( SyntaxHighlighter value )
SyntaxHighlighter get_syntax_highlighter ( )

There is currently no description for this property. Please help us by contributing one!

String text = ""

void set_text ( String value )
String get_text ( )

There is currently no description for this property. Please help us by contributing one!

TextDirection text_direction = 0

void set_text_direction ( TextDirection value )
TextDirection get_text_direction ( )

There is currently no description for this property. Please help us by contributing one!

bool use_custom_word_separators = false

void set_use_custom_word_separators ( bool value )
bool is_custom_word_separators_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool use_default_word_separators = true

void set_use_default_word_separators ( bool value )
bool is_default_word_separators_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool virtual_keyboard_enabled = true

void set_virtual_keyboard_enabled ( bool value )
bool is_virtual_keyboard_enabled ( )

There is currently no description for this property. Please help us by contributing one!

LineWrappingMode wrap_mode = 0

void set_line_wrapping_mode ( LineWrappingMode value )
LineWrappingMode get_line_wrapping_mode ( )

There is currently no description for this property. Please help us by contributing one!