LineEdit

Inherits: Control < CanvasItem < Node < Object

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

Properties

HorizontalAlignment	alignment	`0`
bool	caret_blink	`false`
float	caret_blink_interval	`0.65`
int	caret_column	`0`
bool	caret_force_displayed	`false`
bool	caret_mid_grapheme	`false`
bool	clear_button_enabled	`false`
bool	context_menu_enabled	`true`
bool	deselect_on_focus_loss_enabled	`true`
bool	drag_and_drop_selection_enabled	`true`
bool	draw_control_chars	`false`
bool	editable	`true`
bool	expand_to_text_length	`false`
bool	flat	`false`
FocusMode	focus_mode	`2` (overrides Control)
String	language	`""`
int	max_length	`0`
bool	middle_mouse_paste_enabled	`true`
CursorShape	mouse_default_cursor_shape	`1` (overrides Control)
String	placeholder_text	`""`
Texture2D	right_icon
bool	secret	`false`
String	secret_character	`"•"`
bool	select_all_on_focus	`false`
bool	selecting_enabled	`true`
bool	shortcut_keys_enabled	`true`
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
String	text	`""`
TextDirection	text_direction	`0`
bool	virtual_keyboard_enabled	`true`
VirtualKeyboardType	virtual_keyboard_type	`0`

Methods

void	clear ( )
void	delete_char_at_caret ( )
void	delete_text ( int from_column, int to_column )
void	deselect ( )
PopupMenu	get_menu ( ) const
float	get_scroll_offset ( ) const
String	get_selected_text ( )
int	get_selection_from_column ( ) const
int	get_selection_to_column ( ) const
bool	has_selection ( ) const
void	insert_text_at_caret ( String text )
bool	is_menu_visible ( ) const
void	menu_option ( int option )
void	select ( int from=0, int to=-1 )
void	select_all ( )

Theme Properties

Color	caret_color	`Color(0.95, 0.95, 0.95, 1)`
Color	clear_button_color	`Color(0.875, 0.875, 0.875, 1)`
Color	clear_button_color_pressed	`Color(1, 1, 1, 1)`
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_selected_color	`Color(1, 1, 1, 1)`
Color	font_uneditable_color	`Color(0.875, 0.875, 0.875, 0.5)`
Color	selection_color	`Color(0.5, 0.5, 0.5, 1)`
int	caret_width	`1`
int	minimum_character_width	`4`
int	outline_size	`0`
Font	font
int	font_size
Texture2D	clear
StyleBox	focus
StyleBox	normal
StyleBox	read_only

Signals

text_change_rejected ( String rejected_substring )

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

text_changed ( String new_text )

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

text_submitted ( String new_text )

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 VirtualKeyboardType:

VirtualKeyboardType KEYBOARD_TYPE_DEFAULT = 0

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

VirtualKeyboardType KEYBOARD_TYPE_MULTILINE = 1

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

VirtualKeyboardType KEYBOARD_TYPE_NUMBER = 2

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

VirtualKeyboardType KEYBOARD_TYPE_NUMBER_DECIMAL = 3

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

VirtualKeyboardType KEYBOARD_TYPE_PHONE = 4

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

VirtualKeyboardType KEYBOARD_TYPE_EMAIL_ADDRESS = 5

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

VirtualKeyboardType KEYBOARD_TYPE_PASSWORD = 6

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

VirtualKeyboardType KEYBOARD_TYPE_URL = 7

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

Property Descriptions

HorizontalAlignment alignment = 0

void set_horizontal_alignment ( HorizontalAlignment value )
HorizontalAlignment get_horizontal_alignment ( )

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!

int caret_column = 0

void set_caret_column ( int value )
int get_caret_column ( )

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

bool caret_force_displayed = false

void set_caret_force_displayed ( bool value )
bool is_caret_force_displayed ( )

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 clear_button_enabled = false

void set_clear_button_enabled ( bool value )
bool is_clear_button_enabled ( )

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!

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 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 expand_to_text_length = false

void set_expand_to_text_length_enabled ( bool value )
bool is_expand_to_text_length_enabled ( )

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

bool flat = false

void set_flat ( bool value )
bool is_flat ( )

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!

int max_length = 0

void set_max_length ( int value )
int get_max_length ( )

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!

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!

Texture2D right_icon

void set_right_icon ( Texture2D value )
Texture2D get_right_icon ( )

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

bool secret = false

void set_secret ( bool value )
bool is_secret ( )

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

String secret_character = "•"

void set_secret_character ( String value )
String get_secret_character ( )

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

bool select_all_on_focus = false

void set_select_all_on_focus ( bool value )
bool is_select_all_on_focus ( )

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!

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 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!

VirtualKeyboardType virtual_keyboard_type = 0

void set_virtual_keyboard_type ( VirtualKeyboardType value )
VirtualKeyboardType get_virtual_keyboard_type ( )

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

Method Descriptions

void clear ( )

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

void delete_char_at_caret ( )

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

void delete_text ( int from_column, int to_column )

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

void deselect ( )

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

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

float get_scroll_offset ( ) const

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

String get_selected_text ( )

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

int get_selection_from_column ( ) const

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

int get_selection_to_column ( ) const

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

bool has_selection ( ) const

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

void insert_text_at_caret ( String text )

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

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

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

void select ( int from=0, int to=-1 )

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

void select_all ( )

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

Theme Property Descriptions

Color caret_color = Color(0.95, 0.95, 0.95, 1)

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

Color clear_button_color = Color(0.875, 0.875, 0.875, 1)

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

Color clear_button_color_pressed = Color(1, 1, 1, 1)

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

Color font_color = Color(0.875, 0.875, 0.875, 1)

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

Color font_outline_color = Color(0, 0, 0, 1)

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

Color font_placeholder_color = Color(0.875, 0.875, 0.875, 0.6)

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

Color font_selected_color = Color(1, 1, 1, 1)

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

Color font_uneditable_color = Color(0.875, 0.875, 0.875, 0.5)

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

Color selection_color = Color(0.5, 0.5, 0.5, 1)

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

int caret_width = 1

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

int minimum_character_width = 4

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

int outline_size = 0

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

Font font

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

int font_size

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

Texture2D clear

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

StyleBox focus

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

StyleBox normal

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

StyleBox read_only

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