wiki.sine.space | sinespace

Scripting/SUIInputField

From wiki.sine.space
Revision as of 15:45, 27 December 2020 by Voidtech (Talk | contribs) (Added and defined all members of SUIInputField (21))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Members

OnEndEdit

void OnEndEdit (closure callback)

Given function will be called when editing has ended


OnValueChanged

void OnValueChanged (closure callback)

Given function will be called when text in Input Field has changed



Properties

AsteriskChar

char AsteriskChar { get; set; }

The character used for password fields.


CaretBlinkRate

float CaretBlinkRate { get; set; }

The blinking rate of the input caret, defined as the number of times the blink cycle occurs per second.


CaretPosition

int CaretPosition { get; set; }

Current InputField caret position (also selection tail).


CaretWidth

int CaretWidth { get; set; }

The width of the caret in pixels.


CharacterLimit

int CharacterLimit { get; set; }

No documentation


Enabled

bool Enabled { get; set; }

Whether this Input Field component is Enabled or not


Interactable

bool Interactable { get; set; }

Is the Input Field interactable?


IsFocused

bool IsFocused { get;}

Does the InputField currently have focus and is able to process events.


ReadOnly

bool ReadOnly { get;set; }

Set the InputField to be read only.


SelectionAnchorPosition

int SelectionAnchorPosition { get;set;}

The beginning point of the selection.


SelectionFocusPosition

int SelectionFocusPosition { get;set; }

The end point of the selection.


Text

string Text { get;set; }

The current value of the input field.


FlexibleHeight

float FlexibleHeight { get;}

The extra relative height this UIText should be allocated if there is additional available space. (Used by the Layout system)


FlexibleWidth

float FlexibleWidth { get;}

The extra relative width this UIText should be allocated if there is additional available space. (Used by the Layout system)


MinHeight

float MinHeight { get;}

The minimum height this UIText may be allocated.(Used by the Layout system).


MinWidth

float MinWidth { get;}

The minimum width this UIText may be allocated. (Used by the Layout system).


MultiLine

bool MultiLine { get;}

If the input field supports multiple lines.


PreferredHeight

float PreferredHeight { get;}

The preferred height this UIText should be allocated if there is sufficient space. (Used by the Layout system)


PreferredWidth

bool PreferredWidth { get; }

The preferred width this UIText should be allocated if there is sufficient space. (Used by the Layout system)