LineEditclass
A single line text entry. See `Editor.TextEdit` for multi line version.
Constructors2
Showing 2 constructors
No results match this filter.
Methods26
Showing 26 methods
public void AddHistory(string text)
| Parameter | Type | Description |
|---|---|---|
| text | string | — |
void—public void Clear()
Clear the text.
void—public void Copy()
void—public void Cut()
void—public void Deselect()
De-select all of the text.
void—protected virtual bool FocusNext()
If we have our menus open, let use tab/shift tab to navigate instead of switching to next control
bool—protected virtual bool FocusPrevious()
If we have our menus open, let use tab/shift tab to navigate instead of switching to next control
bool—public void Insert(string val)
| Parameter | Type | Description |
|---|---|---|
| val | string | — |
void—protected virtual void OnBlur(Editor.FocusChangeReason reason)
| Parameter | Type | Description |
|---|---|---|
| reason | FocusChangeReason | — |
void—protected virtual void OnEditingFinished()
The text entry lost keyboard focus.
void—protected virtual void OnFocus(Editor.FocusChangeReason reason)
| Parameter | Type | Description |
|---|---|---|
| reason | FocusChangeReason | — |
void—protected virtual void OnReturnPressed()
Called when the user presses the return (Enter) key.
void—protected virtual void OnTextChanged(string value)
Called when the input text changes.
| Parameter | Type | Description |
|---|---|---|
| value | string | — |
void—protected virtual void OnTextEdited(string value)
Called when the text was edited.
| Parameter | Type | Description |
|---|---|---|
| value | string | — |
void—public void Paste()
void—public void Redo()
void—public virtual void RestoreHistoryFromCookie()
void—public virtual void SaveHistoryCookie()
void—public void SelectAll()
Select all of the text.
void—public void SetAutoComplete(System.Action`2<Editor.Menu,string> func)
| Parameter | Type | Description |
|---|---|---|
| func | Action<Menu,string> | — |
void—public void SetSelection(int start, int length)
Set the selected text region.
| Parameter | Type | Description |
|---|---|---|
| start | int | — |
| length | int | — |
void—public void SetValidator(string str)
| Parameter | Type | Description |
|---|---|---|
| str | string | — |
void—public void Undo()
void—No results match this filter.
Properties21
Showing 21 properties
public Editor.AutoComplete Editor.LineEdit.AutoComplete { get; set; }
public bool Editor.LineEdit.AutoCompleteVisible { get; set; }
Whether the auto complete`Editor.Menu` is visible or not.
bool—public bool Editor.LineEdit.ClearButtonEnabled { get; set; }
Show a button to clear the text input when it is not empty.
bool—public int Editor.LineEdit.CursorPosition { get; set; }
Position of the text cursor, at which newly typed letters will be inserted.
int—public string Editor.LineEdit.DisplayText { get; set; }
string—public Editor.Widget Editor.LineEdit.ForwardNavigationEvents { get; set; }
Forward up, down and enter keys to this control. This is useful if you have a search box that you want to also allow to navigate a list of items.
public bool Editor.LineEdit.HasSelectedText { get; set; }
Whether the user has any text selected within this text entry.
bool—public string Editor.LineEdit.HistoryCookie { get; set; }
string—public bool Editor.LineEdit.HistoryVisible { get; set; }
True if history menu is visible
bool—public int Editor.LineEdit.MaxHistoryItems { get; set; }
if set > 1 we will support history items (which you need to add using AddHistory)
int—public int Editor.LineEdit.MaxLength { get; set; }
User entered text can never be longer than this many characters (not bytes).
int—public string Editor.LineEdit.PlaceholderText { get; set; }
The placeholder text, it will be displayed only when the text entry is empty. Typically used to as a short description of the expected input, or as an example input.
string—public virtual bool Editor.LineEdit.ReadOnly { get; set; }
bool—public string Editor.LineEdit.RegexValidator { get; set; }
string—public string Editor.LineEdit.SelectedText { get; set; }
The selected text, if any.
string—public int Editor.LineEdit.SelectionEnd { get; set; }
Character at which the text selection ends, or -1 if there is no selection.
int—public int Editor.LineEdit.SelectionStart { get; set; }
Character at which the text selection begins, or -1 if there is no selection.
int—public string Editor.LineEdit.Text { get; set; }
The text of this text entry.
string—public virtual string Editor.LineEdit.Value { get; set; }
Alias of `Editor.LineEdit.Text`, except disallows setting text when `Editor.Widget.IsFocused` is .
string—No results match this filter.