LineEdit

Control that provides single line string editing.

LineEdit provides a single line string editor, used for text fields.

@GodotBaseClass

struct LineEdit {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(LineEdit other);

LineEdit opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static LineEdit _new();

enum MenuItems;

enum Constants;

void _textChanged();

void _toggleDrawCaret();

void _editorSettingsChanged();

void setAlign(long _align);

LineEdit.Align getAlign();

void _guiInput(InputEvent arg0);

void clear();

void select(long from, long to);

void selectAll();

void deselect();

void setText(StringArg0 text);

String getText();

void setPlaceholder(StringArg0 text);

String getPlaceholder();

void setPlaceholderAlpha(double alpha);

double getPlaceholderAlpha();

void setCursorPosition(long position);

long getCursorPosition();

void setExpandToTextLength(bool enabled);

bool getExpandToTextLength();

void cursorSetBlinkEnabled(bool enabled);

bool cursorGetBlinkEnabled();

void cursorSetBlinkSpeed(double blink_speed);

double cursorGetBlinkSpeed();

void setMaxLength(long chars);

long getMaxLength();

void appendAtCursor(StringArg0 text);

void setEditable(bool enabled);

bool isEditable();

void setSecret(bool enabled);

bool isSecret();

void setSecretCharacter(StringArg0 character);

String getSecretCharacter();

void menuOption(long option);

PopupMenu getMenu();

void setContextMenuEnabled(bool enable);

bool isContextMenuEnabled();

void setClearButtonEnabled(bool enable);

bool isClearButtonEnabled();

String text [@property getter];

String text [@property setter];

LineEdit.Align _align [@property getter];

long _align [@property setter];

long maxLength [@property getter];

long maxLength [@property setter];

bool editable [@property getter];

bool editable [@property setter];

bool secret [@property getter];

bool secret [@property setter];

String secretCharacter [@property getter];

String secretCharacter [@property setter];

bool expandToTextLength [@property getter];

bool expandToTextLength [@property setter];

Control.FocusMode focusMode [@property getter];

long focusMode [@property setter];

bool contextMenuEnabled [@property getter];

bool contextMenuEnabled [@property setter];

bool clearButtonEnabled [@property getter];

bool clearButtonEnabled [@property setter];

String placeholderText [@property getter];

String placeholderText [@property setter];

double placeholderAlpha [@property getter];

double placeholderAlpha [@property setter];

bool caretBlink [@property getter];

bool caretBlink [@property setter];

double caretBlinkSpeed [@property getter];

double caretBlinkSpeed [@property setter];

long caretPosition [@property getter];

long caretPosition [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Align enum Align
Constants enum Constants
MenuItems enum MenuItems

Functions

_editorSettingsChanged void _editorSettingsChanged()
_guiInput void _guiInput(InputEvent arg0)
_textChanged void _textChanged()
_toggleDrawCaret void _toggleDrawCaret()
appendAtCursor void appendAtCursor(StringArg0 text): Adds text after the cursor. If the resulting value is longer than maxLength, nothing happens.
clear void clear(): Erases the LineEdit text.
cursorGetBlinkEnabled bool cursorGetBlinkEnabled()
cursorGetBlinkSpeed double cursorGetBlinkSpeed()
cursorSetBlinkEnabled void cursorSetBlinkEnabled(bool enabled)
cursorSetBlinkSpeed void cursorSetBlinkSpeed(double blink_speed)
deselect void deselect(): Clears the current selection.
getAlign LineEdit.Align getAlign()
getCursorPosition long getCursorPosition()
getExpandToTextLength bool getExpandToTextLength()
getMaxLength long getMaxLength()
getMenu PopupMenu getMenu(): Returns the PopupMenu of this LineEdit. By default, this menu is displayed when right-clicking on the LineEdit.
getPlaceholder String getPlaceholder()
getPlaceholderAlpha double getPlaceholderAlpha()
getSecretCharacter String getSecretCharacter()
getText String getText()
isClearButtonEnabled bool isClearButtonEnabled()
isContextMenuEnabled bool isContextMenuEnabled()
isEditable bool isEditable()
isSecret bool isSecret()
menuOption void menuOption(long option): Executes a given action as defined in the MENU_* enum.
opAssign LineEdit opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(LineEdit other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
select void select(long from, long to): Selects characters inside LineEdit between from and to. By default from is at the beginning and to at the end.
selectAll void selectAll(): Selects the whole String.
setAlign void setAlign(long _align)
setClearButtonEnabled void setClearButtonEnabled(bool enable)
setContextMenuEnabled void setContextMenuEnabled(bool enable)
setCursorPosition void setCursorPosition(long position)
setEditable void setEditable(bool enabled)
setExpandToTextLength void setExpandToTextLength(bool enabled)
setMaxLength void setMaxLength(long chars)
setPlaceholder void setPlaceholder(StringArg0 text)
setPlaceholderAlpha void setPlaceholderAlpha(double alpha)
setSecret void setSecret(bool enabled)
setSecretCharacter void setSecretCharacter(StringArg0 character)
setText void setText(StringArg0 text)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

_align LineEdit.Align _align [@property getter]
long _align [@property setter]: Text alignment as defined in the ALIGN_* enum.
caretBlink bool caretBlink [@property getter]
bool caretBlink [@property setter]: If true the caret (visual cursor) blinks.
caretBlinkSpeed double caretBlinkSpeed [@property getter]
double caretBlinkSpeed [@property setter]: Duration (in seconds) of a caret's blinking cycle.
caretPosition long caretPosition [@property getter]
long caretPosition [@property setter]: The cursor's position inside the LineEdit. When set, the text may scroll to accommodate it.
clearButtonEnabled bool clearButtonEnabled [@property getter]
bool clearButtonEnabled [@property setter]: If true the LineEdit will show a clear button if text is not empty.
contextMenuEnabled bool contextMenuEnabled [@property getter]
bool contextMenuEnabled [@property setter]: If true the context menu will appear when right clicked.
editable bool editable [@property getter]
bool editable [@property setter]: If false existing text cannot be modified and new text cannot be added.
expandToTextLength bool expandToTextLength [@property getter]
bool expandToTextLength [@property setter]: If true the LineEdit width will increase to stay longer than the text. It will not compress if the text is shortened.
focusMode Control.FocusMode focusMode [@property getter]
long focusMode [@property setter]: Defines how the LineEdit can grab focus (Keyboard and mouse, only keyboard, or none). See enum FocusMode in Control for details.
maxLength long maxLength [@property getter]
long maxLength [@property setter]: Maximum amount of characters that can be entered inside the LineEdit. If 0, there is no limit.
placeholderAlpha double placeholderAlpha [@property getter]
double placeholderAlpha [@property setter]: Opacity of the placeholderText. From 0 to 1.
placeholderText String placeholderText [@property getter]
String placeholderText [@property setter]: Text shown when the LineEdit is empty. It is not the LineEdit's default value (see text).
secret bool secret [@property getter]
bool secret [@property setter]: If true, every character is replaced with the secret character (see secretCharacter).
secretCharacter String secretCharacter [@property getter]
String secretCharacter [@property setter]: The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character.
text String text [@property getter]
String text [@property setter]: String value of the LineEdit.

Static functions

_new LineEdit _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot lineedit structs

LineEdit