diff options
Diffstat (limited to 'doc/classes/LineEdit.xml')
| -rw-r--r-- | doc/classes/LineEdit.xml | 103 |
1 files changed, 68 insertions, 35 deletions
diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index e6c26e3248..432f583566 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LineEdit" inherits="Control" category="Core" version="3.0.alpha.custom_build"> +<class name="LineEdit" inherits="Control" category="Core" version="3.0-alpha"> <brief_description> Control that provides single line string editing. </brief_description> @@ -17,14 +17,14 @@ <argument index="0" name="text" type="String"> </argument> <description> - Append text at cursor, scrolling the [LineEdit] when needed. + 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> - Clear the [LineEdit] text. + Erases the [LineEdit] text. </description> </method> <method name="cursor_get_blink_enabled" qualifiers="const"> @@ -63,14 +63,14 @@ <return type="int" enum="LineEdit.Align"> </return> <description> - Return the align mode of the [LineEdit]. + Return the align mode of the [code]LineEdit[/code]. </description> </method> <method name="get_cursor_position" qualifiers="const"> <return type="int"> </return> <description> - Return the cursor position inside the [LineEdit]. + Returns the cursor position inside the [code]LineEdit[/code]. </description> </method> <method name="get_expand_to_text_length" qualifiers="const"> @@ -83,14 +83,14 @@ <return type="int"> </return> <description> - Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. + 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> - Return the [PopupMenu] of this [LineEdit]. + 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"> @@ -111,21 +111,28 @@ <return type="String"> </return> <description> - Return the text in the [LineEdit]. + 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 [LineEdit] (see [method set_editable]). + 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 [LineEdit] (see [method set_secret]). + Return the [i]secret[/i] status of the [code]LineEdit[/code] (see [method set_secret]). </description> </method> <method name="menu_option"> @@ -134,7 +141,7 @@ <argument index="0" name="option" type="int"> </argument> <description> - Execute a given action as defined in the MENU_* enum. + Executes a given action as defined in the MENU_* enum. </description> </method> <method name="select"> @@ -145,11 +152,12 @@ <argument index="1" name="to" type="int" default="-1"> </argument> <description> - Select the text inside [LineEdit] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. + 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] - select() # select all - select(5) # select from the fifth character to the end. - select(2, 5) # select from the second to the fifth character. + text = "Welcome" + select() # Welcome + select(4) # ome + select(2, 5) # lco [/codeblock] </description> </method> @@ -157,7 +165,7 @@ <return type="void"> </return> <description> - Select the whole string. + Selects the whole [String]. </description> </method> <method name="set_align"> @@ -166,7 +174,16 @@ <argument index="0" name="align" type="int" enum="LineEdit.Align"> </argument> <description> - Set text alignment of the [LineEdit]. + 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"> @@ -175,7 +192,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Set the cursor position inside the [LineEdit], causing it to scroll if needed. + Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed. </description> </method> <method name="set_editable"> @@ -184,7 +201,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. + 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"> @@ -201,7 +218,7 @@ <argument index="0" name="chars" type="int"> </argument> <description> - Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. + 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"> @@ -228,7 +245,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". + Set the [i]secret[/i] status of the [code]LineEdit[/code]. When enabled, every character is displayed as "*". </description> </method> <method name="set_text"> @@ -237,32 +254,46 @@ <argument index="0" name="text" type="String"> </argument> <description> - Set the text in the [LineEdit], clearing the existing one and the selection. + 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> @@ -270,49 +301,51 @@ <argument index="0" name="text" type="String"> </argument> <description> - When the text changes, this signal is emitted. + Emitted when the text changes. </description> </signal> <signal name="text_entered"> <argument index="0" name="text" type="String"> </argument> <description> - This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. + Emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. </description> </signal> </signals> <constants> <constant name="ALIGN_LEFT" value="0"> - Align left. + Aligns the text on the left hand side of the [LineEdit]. </constant> <constant name="ALIGN_CENTER" value="1"> - Align center. + Centers the text in the middle of the [LineEdit]. </constant> <constant name="ALIGN_RIGHT" value="2"> - Align right. + Aligns the text on the right hand side of the [LineEdit]. </constant> <constant name="ALIGN_FILL" value="3"> - Align fill. + Stretches whitespaces to fit the [LineEdit]'s width. </constant> <constant name="MENU_CUT" value="0"> - Cut (Copy and clear). + Cuts (Copies and clears) the selected text. </constant> <constant name="MENU_COPY" value="1"> - Copy the selected text. + Copies the selected text. </constant> <constant name="MENU_PASTE" value="2"> - Paste the clipboard text over the selected text. + Pastes the clipboard text over the selected text (or at the cursor's position). </constant> <constant name="MENU_CLEAR" value="3"> - Clear the text. + Erases the whole [Linedit] text. </constant> <constant name="MENU_SELECT_ALL" value="4"> - Select all text. + Selects the whole [Linedit] text. </constant> <constant name="MENU_UNDO" value="5"> - Undo an action. + Undoes the previous action. + </constant> + <constant name="MENU_REDO" value="6"> </constant> - <constant name="MENU_MAX" value="6"> + <constant name="MENU_MAX" value="7"> </constant> </constants> <theme_items> |