Libraries.Interface.Events.TextInputEvent Documentation

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetText()

Return

text

GetUnicodeValue()

Return

integer

SetKeyUsed(boolean used)

This action indicates if the text input from this event was produced using a keypress that has already been used to trigger a Behavior elsewhere in the engine. For example, pressing CONTROL + SPACE in a code editor text box might open code completion, and then also produce a "Space" text input -- in this case, this value would return true.

Parameters

  • boolean used

SetText(text newValue)

Parameters

  • text newValue

SetUnicodeValue(integer value)

Parameters

  • integer value

WasKeyUsed()

This action indicates if the text input from this event was produced using a keypress that has already been used to trigger a Behavior elsewhere in the engine. For example, pressing CONTROL + SPACE in a code editor text box might open code completion, and then also produce a "Space" text input -- in this case, this value would return true.

Return

boolean: