Libraries.Interface.Events.TextInputEvent Documentation

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetText()
GetUnicodeValue()
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.
SetText(text newValue)
SetUnicodeValue(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.

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.

Example Code

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

Parameters

Return

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

Equals(Libraries.Language.Object object)

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

Example Code

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

Parameters

Return

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

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode

Return

integer: The integer hash code of the object.

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 tru

Parameters

SetText(text newValue)

Parameters

SetUnicodeValue(integer value)

Parameters

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 tru

Return

boolean: