diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-09-26 18:45:46 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-09-26 18:45:46 +0200 |
| commit | 3cde5a37f98552ef10b73091c058a5802ace08db (patch) | |
| tree | 08956c0476ff1d5c80ee41820be23191cea73747 /doc | |
| parent | 807136b679e9160a7819adc6ccbcff4ef975d598 (diff) | |
| parent | b3d413d4b4eec44d7651a75f2c4ed7aebfbf044e (diff) | |
| download | redot-engine-3cde5a37f98552ef10b73091c058a5802ace08db.tar.gz | |
Merge pull request #97455 from Calinou/doc-lineedit-text-submitted
Clarify when LineEdit's `text_submitted` signal is emitted
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/LineEdit.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 9c460e6d62..41f42392de 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -6,11 +6,11 @@ <description> [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 or press the "ui_text_submit" action (default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]). - - To exit edit mode, press "ui_text_submit" or "ui_cancel" (default: [kbd]Escape[/kbd]) actions. + - To enter edit mode, click on the control with the mouse or press the [code]ui_text_submit[/code] action (by default [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]). + - To exit edit mode, press [code]ui_text_submit[/code] or [code]ui_cancel[/code] (by default [kbd]Escape[/kbd]) actions. - Check [method is_editing] and [signal editing_toggled] for more information. [b]Important:[/b] - - Focusing the [LineEdit] with "ui_focus_next" (default: [kbd]Tab[/kbd]) or "ui_focus_prev" (default: [kbd]Shift + Tab[/kbd]) or [method Control.grab_focus] still enters edit mode (for compatibility). + - 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 @@ -365,7 +365,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> |