2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name= "LineEdit" inherits= "Control" category= "Core" version= "3.1.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
Control that provides single line string editing.
</brief_description>
<description >
LineEdit provides a single line string editor, used for text fields.
</description>
<tutorials >
</tutorials>
<methods >
<method name= "append_at_cursor" >
<return type= "void" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
2017-10-27 22:00:22 +00:00
Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "clear" >
<return type= "void" >
</return>
<description >
2019-01-07 09:02:04 +00:00
Erases the [code]LineEdit[/code] text.
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-12-17 17:40:44 +00:00
<method name= "deselect" >
<return type= "void" >
</return>
<description >
Clears the current selection.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_menu" qualifiers= "const" >
<return type= "PopupMenu" >
</return>
<description >
2019-01-07 09:02:04 +00:00
Returns the [PopupMenu] of this [code]LineEdit[/code]. By default, this menu is displayed when right-clicking on the [code]LineEdit[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "menu_option" >
<return type= "void" >
</return>
<argument index= "0" name= "option" type= "int" >
</argument>
<description >
2017-10-27 22:00:22 +00:00
Executes a given action as defined in the MENU_* enum.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "select" >
<return type= "void" >
</return>
<argument index= "0" name= "from" type= "int" default= "0" >
</argument>
<argument index= "1" name= "to" type= "int" default= "-1" >
</argument>
<description >
2019-01-07 09:02:04 +00:00
Selects characters inside [code]LineEdit[/code] between [code]from[/code] and [code]to[/code]. By default [code]from[/code] is at the beginning and [code]to[/code] at the end.
2017-09-12 20:42:36 +00:00
[codeblock]
2017-10-27 22:00:22 +00:00
text = "Welcome"
select() # Welcome
select(4) # ome
select(2, 5) # lco
2017-09-12 20:42:36 +00:00
[/codeblock]
</description>
</method>
<method name= "select_all" >
<return type= "void" >
</return>
<description >
2017-10-27 22:00:22 +00:00
Selects the whole [String].
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members >
2017-09-13 06:49:40 +00:00
<member name= "align" type= "int" setter= "set_align" getter= "get_align" enum= "LineEdit.Align" >
2017-10-27 22:00:22 +00:00
Text alignment as defined in the ALIGN_* enum.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "caret_blink" type= "bool" setter= "cursor_set_blink_enabled" getter= "cursor_get_blink_enabled" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the caret (visual cursor) blinks.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "caret_blink_speed" type= "float" setter= "cursor_set_blink_speed" getter= "cursor_get_blink_speed" >
2017-10-27 22:00:22 +00:00
Duration (in seconds) of a caret's blinking cycle.
2017-09-12 20:42:36 +00:00
</member>
2018-01-11 22:38:35 +00:00
<member name= "caret_position" type= "int" setter= "set_cursor_position" getter= "get_cursor_position" >
2018-01-18 20:37:17 +00:00
The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accommodate it.
2018-01-11 22:38:35 +00:00
</member>
2018-08-20 22:35:30 +00:00
<member name= "clear_button_enabled" type= "bool" setter= "set_clear_button_enabled" getter= "is_clear_button_enabled" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the [code]LineEdit[/code] will show a clear button if [code]text[/code] is not empty.
2018-08-20 22:35:30 +00:00
</member>
2017-11-13 08:24:36 +00:00
<member name= "context_menu_enabled" type= "bool" setter= "set_context_menu_enabled" getter= "is_context_menu_enabled" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the context menu will appear when right clicked.
2017-11-13 08:24:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "editable" type= "bool" setter= "set_editable" getter= "is_editable" >
2018-12-20 12:46:54 +00:00
If [code]false[/code], existing text cannot be modified and new text cannot be added.
2017-09-12 20:42:36 +00:00
</member>
2017-11-24 08:16:27 +00:00
<member name= "expand_to_text_length" type= "bool" setter= "set_expand_to_text_length" getter= "get_expand_to_text_length" >
2019-01-07 09:02:04 +00:00
If [code]true[/code], the [code]LineEdit[/code] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "focus_mode" type= "int" setter= "set_focus_mode" getter= "get_focus_mode" enum= "Control.FocusMode" >
2019-01-07 09:02:04 +00:00
Defines how the [code]LineEdit[/code] can grab focus (Keyboard and mouse, only keyboard, or none). See [code]enum FocusMode[/code] in [Control] for details.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "max_length" type= "int" setter= "set_max_length" getter= "get_max_length" >
2019-01-07 09:02:04 +00:00
Maximum amount of characters that can be entered inside the [code]LineEdit[/code]. If [code]0[/code], there is no limit.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "placeholder_alpha" type= "float" setter= "set_placeholder_alpha" getter= "get_placeholder_alpha" >
2017-10-27 22:00:22 +00:00
Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code].
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "placeholder_text" type= "String" setter= "set_placeholder" getter= "get_placeholder" >
2019-01-07 09:02:04 +00:00
Text shown when the [code]LineEdit[/code] is empty. It is [b]not[/b] the [code]LineEdit[/code]'s default value (see [member text]).
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "secret" type= "bool" setter= "set_secret" getter= "is_secret" >
2018-04-28 18:24:48 +00:00
If [code]true[/code], every character is replaced with the secret character (see [member secret_character]).
</member>
2018-05-12 07:38:00 +00:00
<member name= "secret_character" type= "String" setter= "set_secret_character" getter= "get_secret_character" >
2018-04-28 18:24:48 +00:00
The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "text" type= "String" setter= "set_text" getter= "get_text" >
2019-01-07 09:02:04 +00:00
String value of the [code]LineEdit[/code].
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals >
<signal name= "text_changed" >
2018-01-09 15:39:43 +00:00
<argument index= "0" name= "new_text" type= "String" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2017-10-27 22:00:22 +00:00
Emitted when the text changes.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name= "text_entered" >
2018-01-09 15:39:43 +00:00
<argument index= "0" name= "new_text" type= "String" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-01-07 09:02:04 +00:00
Emitted when the user presses [code]KEY_ENTER[/code] on the [code]LineEdit[/code].
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_LEFT" value= "0" enum= "Align" >
2019-01-07 09:02:04 +00:00
Aligns the text on the left hand side of the [code]LineEdit[/code].
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_CENTER" value= "1" enum= "Align" >
2019-01-07 09:02:04 +00:00
Centers the text in the middle of the [code]LineEdit[/code].
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_RIGHT" value= "2" enum= "Align" >
2019-01-07 09:02:04 +00:00
Aligns the text on the right hand side of the [code]LineEdit[/code].
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_FILL" value= "3" enum= "Align" >
2019-01-07 09:02:04 +00:00
Stretches whitespaces to fit the [code]LineEdit[/code]'s width.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_CUT" value= "0" enum= "MenuItems" >
2019-01-07 09:02:04 +00:00
Cuts (copies and clears) the selected text.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_COPY" value= "1" enum= "MenuItems" >
2017-10-27 22:00:22 +00:00
Copies the selected text.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_PASTE" value= "2" enum= "MenuItems" >
2017-10-27 22:00:22 +00:00
Pastes the clipboard text over the selected text (or at the cursor's position).
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_CLEAR" value= "3" enum= "MenuItems" >
2019-01-07 09:02:04 +00:00
Erases the whole [code]LineEdit[/code] text.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_SELECT_ALL" value= "4" enum= "MenuItems" >
2019-01-07 09:02:04 +00:00
Selects the whole [code]LineEdit[/code] text.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_UNDO" value= "5" enum= "MenuItems" >
2017-10-27 22:00:22 +00:00
Undoes the previous action.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_REDO" value= "6" enum= "MenuItems" >
2018-10-13 15:36:30 +00:00
Reverse the last undo action.
2017-11-13 08:24:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "MENU_MAX" value= "7" enum= "MenuItems" >
2017-09-12 20:42:36 +00:00
</constant>
</constants>
<theme_items >
2018-08-20 22:35:30 +00:00
<theme_item name= "clear" type= "Texture" >
</theme_item>
<theme_item name= "clear_button_color" type= "Color" >
</theme_item>
<theme_item name= "clear_button_color_pressed" type= "Color" >
</theme_item>
2017-09-12 20:42:36 +00:00
<theme_item name= "cursor_color" type= "Color" >
</theme_item>
<theme_item name= "focus" type= "StyleBox" >
</theme_item>
<theme_item name= "font" type= "Font" >
</theme_item>
<theme_item name= "font_color" type= "Color" >
</theme_item>
<theme_item name= "font_color_selected" type= "Color" >
</theme_item>
<theme_item name= "minimum_spaces" type= "int" >
</theme_item>
<theme_item name= "normal" type= "StyleBox" >
</theme_item>
<theme_item name= "read_only" type= "StyleBox" >
</theme_item>
<theme_item name= "selection_color" type= "Color" >
</theme_item>
</theme_items>
</class>