feat: updated engine version to 4.4-rc1
This commit is contained in:
parent
ee00efde1f
commit
21ba8e33af
5459 changed files with 1128836 additions and 198305 deletions
|
|
@ -4,7 +4,14 @@
|
|||
An input field for single-line text.
|
||||
</brief_description>
|
||||
<description>
|
||||
[LineEdit] provides an input field for editing a single line of text. It features many built-in shortcuts that are always available ([kbd]Ctrl[/kbd] here maps to [kbd]Cmd[/kbd] on macOS):
|
||||
[LineEdit] provides an input field for editing a single line of text.
|
||||
- When the [LineEdit] control is focused using the keyboard arrow keys, it will only gain focus and not enter edit mode.
|
||||
- To enter edit mode, click on the control with the mouse, see also [member keep_editing_on_text_submit].
|
||||
- To exit edit mode, press [code]ui_text_submit[/code] or [code]ui_cancel[/code] (by default [kbd]Escape[/kbd]) actions.
|
||||
- Check [method edit], [method unedit], [method is_editing], and [signal editing_toggled] for more information.
|
||||
[b]Important:[/b]
|
||||
- Focusing the [LineEdit] with [code]ui_focus_next[/code] (by default [kbd]Tab[/kbd]) or [code]ui_focus_prev[/code] (by default [kbd]Shift + Tab[/kbd]) or [method Control.grab_focus] still enters edit mode (for compatibility).
|
||||
[LineEdit] features many built-in shortcuts that are always available ([kbd]Ctrl[/kbd] here maps to [kbd]Cmd[/kbd] on macOS):
|
||||
- [kbd]Ctrl + C[/kbd]: Copy
|
||||
- [kbd]Ctrl + X[/kbd]: Cut
|
||||
- [kbd]Ctrl + V[/kbd] or [kbd]Ctrl + Y[/kbd]: Paste/"yank"
|
||||
|
|
@ -26,10 +33,23 @@
|
|||
- [kbd]Cmd + E[/kbd]: Same as [kbd]End[/kbd], move the caret to the end of the line
|
||||
- [kbd]Cmd + Left Arrow[/kbd]: Same as [kbd]Home[/kbd], move the caret to the beginning of the line
|
||||
- [kbd]Cmd + Right Arrow[/kbd]: Same as [kbd]End[/kbd], move the caret to the end of the line
|
||||
[b]Note:[/b] Caret movement shortcuts listed above are not affected by [member shortcut_keys_enabled].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="apply_ime">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Applies text from the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME) and closes the IME if it is open.
|
||||
</description>
|
||||
</method>
|
||||
<method name="cancel_ime">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Closes the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME) if it is open. Any text in the IME will be lost.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear">
|
||||
<return type="void" />
|
||||
<description>
|
||||
|
|
@ -56,6 +76,13 @@
|
|||
Clears the current selection.
|
||||
</description>
|
||||
</method>
|
||||
<method name="edit">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Allows entering edit mode whether the [LineEdit] is focused or not.
|
||||
See also [member keep_editing_on_text_submit].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_menu" qualifiers="const">
|
||||
<return type="PopupMenu" />
|
||||
<description>
|
||||
|
|
@ -126,12 +153,30 @@
|
|||
Returns the selection end column.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_ime_text" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the user has text in the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME).
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_redo" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if a "redo" action is available.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_selection" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the user has selected text.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_undo" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if an "undo" action is available.
|
||||
</description>
|
||||
</method>
|
||||
<method name="insert_text_at_caret">
|
||||
<return type="void" />
|
||||
<param index="0" name="text" type="String" />
|
||||
|
|
@ -139,6 +184,12 @@
|
|||
Inserts [param text] at the caret. If the resulting value is longer than [member max_length], nothing happens.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_editing" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns whether the [LineEdit] is being edited.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_menu_visible" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
|
|
@ -180,6 +231,12 @@
|
|||
Selects the whole [String].
|
||||
</description>
|
||||
</method>
|
||||
<method name="unedit">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Allows exiting edit mode while preserving focus.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="0">
|
||||
|
|
@ -219,6 +276,9 @@
|
|||
<member name="editable" type="bool" setter="set_editable" getter="is_editable" default="true" keywords="readonly, disabled, enabled">
|
||||
If [code]false[/code], existing text cannot be modified and new text cannot be added.
|
||||
</member>
|
||||
<member name="emoji_menu_enabled" type="bool" setter="set_emoji_menu_enabled" getter="is_emoji_menu_enabled" default="true">
|
||||
If [code]true[/code], "Emoji and Symbols" menu is enabled.
|
||||
</member>
|
||||
<member name="expand_to_text_length" type="bool" setter="set_expand_to_text_length_enabled" getter="is_expand_to_text_length_enabled" default="false">
|
||||
If [code]true[/code], the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened.
|
||||
</member>
|
||||
|
|
@ -226,13 +286,16 @@
|
|||
If [code]true[/code], the [LineEdit] doesn't display decoration.
|
||||
</member>
|
||||
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" />
|
||||
<member name="keep_editing_on_text_submit" type="bool" setter="set_keep_editing_on_text_submit" getter="is_editing_kept_on_text_submit" default="false">
|
||||
If [code]true[/code], the [LineEdit] will not exit edit mode when text is submitted by pressing [code]ui_text_submit[/code] action (by default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]).
|
||||
</member>
|
||||
<member name="language" type="String" setter="set_language" getter="get_language" default="""">
|
||||
Language code used for line-breaking and text shaping algorithms. If left empty, current locale is used instead.
|
||||
</member>
|
||||
<member name="max_length" type="int" setter="set_max_length" getter="get_max_length" default="0">
|
||||
Maximum number of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.
|
||||
When a limit is defined, characters that would exceed [member max_length] are truncated. This happens both for existing [member text] contents when setting the max length, or for new text inserted in the [LineEdit], including pasting. If any input text is truncated, the [signal text_change_rejected] signal is emitted with the truncated substring as parameter.
|
||||
[b]Example:[/b]
|
||||
When a limit is defined, characters that would exceed [member max_length] are truncated. This happens both for existing [member text] contents when setting the max length, or for new text inserted in the [LineEdit], including pasting.
|
||||
If any input text is truncated, the [signal text_change_rejected] signal is emitted with the truncated substring as parameter:
|
||||
[codeblocks]
|
||||
[gdscript]
|
||||
text = "Hello world"
|
||||
|
|
@ -278,7 +341,7 @@
|
|||
If [code]false[/code], it's impossible to select the text using mouse nor keyboard.
|
||||
</member>
|
||||
<member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true">
|
||||
If [code]false[/code], using shortcuts will be disabled.
|
||||
If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled.
|
||||
</member>
|
||||
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="TextServer.StructuredTextParser" default="0">
|
||||
Set BiDi algorithm override for the structured text.
|
||||
|
|
@ -301,6 +364,12 @@
|
|||
</member>
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="editing_toggled">
|
||||
<param index="0" name="toggled_on" type="bool" />
|
||||
<description>
|
||||
Emitted when the [LineEdit] switches in or out of edit mode.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="text_change_rejected">
|
||||
<param index="0" name="rejected_substring" type="String" />
|
||||
<description>
|
||||
|
|
@ -316,7 +385,7 @@
|
|||
<signal name="text_submitted">
|
||||
<param index="0" name="new_text" type="String" />
|
||||
<description>
|
||||
Emitted when the user presses [constant KEY_ENTER] on the [LineEdit].
|
||||
Emitted when the user presses the [code]ui_text_submit[/code] action (by default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]) while the [LineEdit] has focus.
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
|
|
@ -412,7 +481,10 @@
|
|||
<constant name="MENU_INSERT_SHY" value="29" enum="MenuItems">
|
||||
Inserts soft hyphen (SHY) character.
|
||||
</constant>
|
||||
<constant name="MENU_MAX" value="30" enum="MenuItems">
|
||||
<constant name="MENU_EMOJI_AND_SYMBOL" value="30" enum="MenuItems">
|
||||
Opens system emoji and symbol picker.
|
||||
</constant>
|
||||
<constant name="MENU_MAX" value="31" enum="MenuItems">
|
||||
Represents the size of the [enum MenuItems] enum.
|
||||
</constant>
|
||||
<constant name="KEYBOARD_TYPE_DEFAULT" value="0" enum="VirtualKeyboardType">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue