LineEdit¶

继承¶

Control

简要描述¶

提供单行字符串编辑的控件。

描述¶

LineEdit提供了用于文本字段的单行字符串编辑器。

它具有许多内置的快捷方式，这些快捷方式将始终可用（Ctrl此处映射到macOS上的Command）：

-Ctrl C：复制

-Ctrl X：剪切

-Ctrl V或Ctrl Y：粘贴/“拖动”

-Ctrl Z：撤消

-Ctrl Shift Z：重做

-Ctrl U：从光标位置到行首删除文本

-Ctrl K：从光标位置到行尾删除文本

-Ctrl A：选择所有文本

-向上/向下箭头：将光标移动到行的开头/结尾

在macOS上，可以使用一些额外的键盘快捷键：

-Ctrl F：像向右箭头键一样，将光标向右移动一个字符

-Ctrl B：像向左箭头键一样，将光标向左移动一个字符

-Ctrl P：像向上箭头键一样，将光标移到上一行

-Ctrl N：像向下箭头键一样，将光标移到下一行

-Ctrl D：像Delete键一样，删除光标右侧的字符

-Ctrl H：像Backspace键一样，删除光标左侧的字符

-命令向左箭头：与Home键一样，将光标移至行首

-命令右箭头：像End键一样，将光标移到行尾

成员¶

类型	属性名	默认值
int	align	0
bool	caret_blink	false
float	caret_blink_speed	0.65
int	caret_position	0
bool	clear_button_enabled	false
bool	context_menu_enabled	true
bool	editable	true
bool	expand_to_text_length	false
int	focus_mode	2
int	max_length	0
int	mouse_default_cursor_shape	1
float	placeholder_alpha	0.6
String	placeholder_text	""
Texture	right_icon
bool	secret	false
String	secret_character	"*"
bool	selecting_enabled	true
bool	shortcut_keys_enabled	true
String	text	""

方法¶

返回值类型	方法名称
void	append_at_cursor(text: String)
void	clear()
void	deselect()
PopupMenu	get_menu() const
void	menu_option(option: int)
void	select(from: int = 0, to: int = -1)
void	select_all()

信号¶

text_change_rejected

当字符长度超出max_length时发出。

text_changed

文本更改时发出。

text_entered

当用户在LineEdit上按下KEY_ENTER时发出。

枚举¶

enum Align: - ALIGN_LEFT = 0

在LineEdit的左侧对齐文本。

ALIGN_CENTER = 1

使文本显示在LineEdit的中间。

ALIGN_RIGHT = 2

在LineEdit的右侧对齐文本。

ALIGN_FILL = 3

拉伸空格以适合LineEdit的宽度。

enum MenuItems: - MENU_CUT = 0

剪切（复制并清除）所选文本。

MENU_COPY = 1

复制所选文本。

MENU_PASTE = 2

将剪贴板上的文本粘贴到选定的文本上（或光标的位置）。

不可打印的转义字符会通过String.strip_escapes从操作系统剪贴板中自动删除。

MENU_CLEAR = 3

擦除整个LineEdit文本。

MENU_SELECT_ALL = 4

选择整个LineEdit文本。

MENU_UNDO = 5

撤消上一个动作。

MENU_REDO = 6

撤消上一个撤消操作。

MENU_MAX = 7

表示MenuItems枚举的大小。

常量¶

成员说明¶

int align

Default	0
setter	set_align(value)
getter	get_align

bool caret_blink

Default	false
setter	cursor_set_blink_enabled(value)
getter	cursor_get_blink_enabled

float caret_blink_speed

Default	0.65
setter	cursor_set_blink_speed(value)
getter	cursor_get_blink_speed

int caret_position

Default	0
setter	set_cursor_position(value)
getter	get_cursor_position

bool clear_button_enabled

Default	false
setter	set_clear_button_enabled(value)
getter	is_clear_button_enabled

bool context_menu_enabled

Default	true
setter	set_context_menu_enabled(value)
getter	is_context_menu_enabled

bool editable

Default	true
setter	set_editable(value)
getter	is_editable

bool expand_to_text_length

Default	false
setter	set_expand_to_text_length(value)
getter	get_expand_to_text_length

int focus_mode

Default	2
setter	set_focus_mode(value)
getter	get_focus_mode

int max_length

Default	0
setter	set_max_length(value)
getter	get_max_length

int mouse_default_cursor_shape

Default	1
setter	set_default_cursor_shape(value)
getter	get_default_cursor_shape

float placeholder_alpha

Default	0.6
setter	set_placeholder_alpha(value)
getter	get_placeholder_alpha

String placeholder_text

Default	""
setter	set_placeholder(value)
getter	get_placeholder

Texture right_icon

setter	set_right_icon(value)
getter	get_right_icon

bool secret

Default	false
setter	set_secret(value)
getter	is_secret

String secret_character

Default	"*"
setter	set_secret_character(value)
getter	get_secret_character

bool selecting_enabled

Default	true
setter	set_selecting_enabled(value)
getter	is_selecting_enabled

bool shortcut_keys_enabled

Default	true
setter	set_shortcut_keys_enabled(value)
getter	is_shortcut_keys_enabled

String text

Default	""
setter	set_text(value)
getter	get_text

方法说明¶

append_at_cursor append_at_cursor(text: String)

在光标之后添加text。

clear clear()

擦除LineEdit文本。

deselect deselect()

清除当前选择。

get_menu get_menu() const

返回此LineEdit的PopupMenu。

menu_option menu_option(option: int)

执行MenuItems枚举中定义的给定操作。

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

在from和to之间选择LineEdit内部的字符。

text = "Welcome"
select() # 将选中 "Welcome".
select(4) # 将选中 "ome".
select(2, 5) # 将选中 "lco".

select_all select_all()

选择整个String。