godot/doc/classes/LineEdit.xml
Rémi Verschelde 967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00

372 lines
12 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="LineEdit" inherits="Control" category="Core" version="3.0-alpha">
<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>
<demos>
</demos>
<methods>
<method name="append_at_cursor">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<description>
Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens.
</description>
</method>
<method name="clear">
<return type="void">
</return>
<description>
Erases the [LineEdit] text.
</description>
</method>
<method name="cursor_get_blink_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Gets whether the line edit caret is blinking.
</description>
</method>
<method name="cursor_get_blink_speed" qualifiers="const">
<return type="float">
</return>
<description>
Gets the line edit caret blink speed.
</description>
</method>
<method name="cursor_set_blink_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set the line edit caret to blink.
</description>
</method>
<method name="cursor_set_blink_speed">
<return type="void">
</return>
<argument index="0" name="blink_speed" type="float">
</argument>
<description>
Set the line edit caret blink speed. Cannot be less then or equal to 0.
</description>
</method>
<method name="get_align" qualifiers="const">
<return type="int" enum="LineEdit.Align">
</return>
<description>
Return the align mode of the [code]LineEdit[/code].
</description>
</method>
<method name="get_cursor_position" qualifiers="const">
<return type="int">
</return>
<description>
Returns the cursor position inside the [code]LineEdit[/code].
</description>
</method>
<method name="get_expand_to_text_length" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_max_length" qualifiers="const">
<return type="int">
</return>
<description>
Return the maximum amount of characters the [code]LineEdit[/code] can edit. If 0 is returned, no limit exists.
</description>
</method>
<method name="get_menu" qualifiers="const">
<return type="PopupMenu">
</return>
<description>
Returns the [PopupMenu] of this [code]LineEdit[/code]. By default, this menu is displayed when right-clicking on the [LineEdit].
</description>
</method>
<method name="get_placeholder" qualifiers="const">
<return type="String">
</return>
<description>
Return the placeholder text.
</description>
</method>
<method name="get_placeholder_alpha" qualifiers="const">
<return type="float">
</return>
<description>
Return transparency of the placeholder text.
</description>
</method>
<method name="get_text" qualifiers="const">
<return type="String">
</return>
<description>
Return the text in the [code]LineEdit[/code].
</description>
</method>
<method name="is_context_menu_enabled">
<return type="bool">
</return>
<description>
Returns true if the context menu is enabled.
</description>
</method>
<method name="is_editable" qualifiers="const">
<return type="bool">
</return>
<description>
Return the [i]editable[/i] status of the [code]LineEdit[/code] (see [method set_editable]).
</description>
</method>
<method name="is_secret" qualifiers="const">
<return type="bool">
</return>
<description>
Return the [i]secret[/i] status of the [code]LineEdit[/code] (see [method set_secret]).
</description>
</method>
<method name="menu_option">
<return type="void">
</return>
<argument index="0" name="option" type="int">
</argument>
<description>
Executes a given action as defined in the MENU_* enum.
</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>
Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default [code]from[/code] is at the beginning and [code]to[/code] at the end.
[codeblock]
text = "Welcome"
select() # Welcome
select(4) # ome
select(2, 5) # lco
[/codeblock]
</description>
</method>
<method name="select_all">
<return type="void">
</return>
<description>
Selects the whole [String].
</description>
</method>
<method name="set_align">
<return type="void">
</return>
<argument index="0" name="align" type="int" enum="LineEdit.Align">
</argument>
<description>
Set text alignment of the [code]LineEdit[/code].
</description>
</method>
<method name="set_context_menu_enabled">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set the status of the context menu. When enabled, the context menu will appear when the [code]LineEdit[/code] is right clicked.
</description>
</method>
<method name="set_cursor_position">
<return type="void">
</return>
<argument index="0" name="position" type="int">
</argument>
<description>
Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed.
</description>
</method>
<method name="set_editable">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set the [i]editable[/i] status of the [code]LineEdit[/code]. When disabled, existing text can't be modified and new text can't be added.
</description>
</method>
<method name="set_expand_to_text_length">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_max_length">
<return type="void">
</return>
<argument index="0" name="chars" type="int">
</argument>
<description>
Set the maximum amount of characters the [code]LineEdit[/code] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit.
</description>
</method>
<method name="set_placeholder">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<description>
Set the placeholder text.
</description>
</method>
<method name="set_placeholder_alpha">
<return type="void">
</return>
<argument index="0" name="alpha" type="float">
</argument>
<description>
Set transparency of the placeholder text.
</description>
</method>
<method name="set_secret">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set the [i]secret[/i] status of the [code]LineEdit[/code]. When enabled, every character is displayed as "*".
</description>
</method>
<method name="set_text">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<description>
Set the text in the [code]LineEdit[/code], clearing the existing one and the selection.
</description>
</method>
</methods>
<members>
<member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align">
Text alignment as defined in the ALIGN_* enum.
</member>
<member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled">
If [code]true[/code] the caret (visual cursor) blinks.
</member>
<member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed">
Duration (in seconds) of a caret's blinking cycle.
</member>
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
If [code]true[/code] the context menu will appear when right clicked.
</member>
<member name="editable" type="bool" setter="set_editable" getter="is_editable">
If [code]false[/code] existing text cannot be modified and new text cannot be added.
</member>
<member name="expand_to_len" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length">
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>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode">
Defines how the [LineEdit] can grab focus (Keyboard and mouse, only keyboard, or none). See [code]enum FocusMode[/code] in [Control] for details.
</member>
<member name="max_length" type="int" setter="set_max_length" getter="get_max_length">
Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.
</member>
<member name="placeholder_alpha" type="float" setter="set_placeholder_alpha" getter="get_placeholder_alpha">
Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code].
</member>
<member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder">
Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]).
</member>
<member name="secret" type="bool" setter="set_secret" getter="is_secret">
If [code]true[/code] every character is shown as "*".
</member>
<member name="text" type="String" setter="set_text" getter="get_text">
String value of the [LineEdit].
</member>
</members>
<signals>
<signal name="text_changed">
<argument index="0" name="text" type="String">
</argument>
<description>
Emitted when the text changes.
</description>
</signal>
<signal name="text_entered">
<argument index="0" name="text" type="String">
</argument>
<description>
Emitted when the user presses KEY_ENTER on the [code]LineEdit[/code].
</description>
</signal>
</signals>
<constants>
<constant name="ALIGN_LEFT" value="0">
Aligns the text on the left hand side of the [LineEdit].
</constant>
<constant name="ALIGN_CENTER" value="1">
Centers the text in the middle of the [LineEdit].
</constant>
<constant name="ALIGN_RIGHT" value="2">
Aligns the text on the right hand side of the [LineEdit].
</constant>
<constant name="ALIGN_FILL" value="3">
Stretches whitespaces to fit the [LineEdit]'s width.
</constant>
<constant name="MENU_CUT" value="0">
Cuts (Copies and clears) the selected text.
</constant>
<constant name="MENU_COPY" value="1">
Copies the selected text.
</constant>
<constant name="MENU_PASTE" value="2">
Pastes the clipboard text over the selected text (or at the cursor's position).
</constant>
<constant name="MENU_CLEAR" value="3">
Erases the whole [Linedit] text.
</constant>
<constant name="MENU_SELECT_ALL" value="4">
Selects the whole [Linedit] text.
</constant>
<constant name="MENU_UNDO" value="5">
Undoes the previous action.
</constant>
<constant name="MENU_REDO" value="6">
</constant>
<constant name="MENU_MAX" value="7">
</constant>
</constants>
<theme_items>
<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>