diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 50bff87a80f..850f7247140 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -17,14 +17,14 @@ - Append text at cursor, scrolling the [code]LineEdit[/code] when needed. + Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens. - Clear the [code]LineEdit[/code] text. + Erases the [LineEdit] text. @@ -70,7 +70,7 @@ - Return the cursor position inside the [code]LineEdit[/code]. + Returns the cursor position inside the [code]LineEdit[/code]. @@ -90,7 +90,7 @@ - Return the [PopupMenu] of this [code]LineEdit[/code]. + Returns the [PopupMenu] of this [code]LineEdit[/code]. By default, this menu is displayed when right-clicking on the [LineEdit]. @@ -134,7 +134,7 @@ - Execute a given action as defined in the MENU_* enum. + Executes a given action as defined in the MENU_* enum. @@ -145,11 +145,12 @@ - Select the text inside [code]LineEdit[/code] 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] @@ -157,7 +158,7 @@ - Select the whole string. + Selects the whole [String]. @@ -175,7 +176,7 @@ - Set the cursor position inside the [code]LineEdit[/code], causing it to scroll if needed. + Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed. @@ -243,26 +244,37 @@ + Text alignment as defined in the ALIGN_* enum. + If [code]true[/code] the caret (visual cursor) blinks. + Duration (in seconds) of a caret's blinking cycle. + If [code]false[/code] existing text cannot be modified and new text cannot be added. + 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. + Defines how the [LineEdit] can grab focus (Keyboard and mouse, only keyboard, or none). See [code]enum FocusMode[/code] in [Control] for details. + Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit. + Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code]. + Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]). + If [code]true[/code] every character is shown as "*". + String value of the [LineEdit]. @@ -270,47 +282,47 @@ - When the text changes, this signal is emitted. + Emitted when the text changes. - This signal is emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. This signal is often used as an alternate confirmation mechanism in dialogs. + Emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. - Align left. + Aligns the text on the left hand side of the [LineEdit]. - Align center. + Centers the text in the middle of the [LineEdit]. - Align right. + Aligns the text on the right hand side of the [LineEdit]. - Align fill. + Stretches whitespaces to fit the [LineEdit]'s width. - Cut (Copy and clear). + Cuts (Copies and clears) the selected text. - Copy the selected text. + Copies the selected text. - Paste the clipboard text over the selected text. + Pastes the clipboard text over the selected text (or at the cursor's position). - Clear the text. + Erases the whole [Linedit] text. - Select all text. + Selects the whole [Linedit] text. - Undo an action. + Undoes the previous action.