Enumeration UICommandEventType

Type of valid command events.

Constructors

`Protected`constructor

new UICommandEventType(do_not_, construct_, this_, type_): UICommandEventType
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns UICommandEventType

Values

`Static` `Readonly`Backspace

Backspace = 32

Backspace key was pressed.

`Static` `Readonly`Confirm

Confirm = 34

Enter key was pressed.

`Static` `Readonly`Delete

Delete = 30

Delete key was pressed.

`Static` `Readonly`Escape

Escape = 29

Escape key was pressed.

`Static` `Readonly`FocusGained

FocusGained = 2

UI element gained input focus.

`Static` `Readonly`FocusLost

FocusLost = 1

UI element lost input focus.

`Static` `Readonly`Insert

Insert = 31

Insert key was pressed.

`Static` `Readonly`MoveDown

MoveDown = 8

Input was moved down (for example for navigating an input box).

`Static` `Readonly`MoveEdgeDown

MoveEdgeDown = 14

Input was moved to the down edge (for example for navigating an input box).

`Static` `Readonly`MoveEdgeLeft

MoveEdgeLeft = 3

Input was moved to the left over an edge (for example for navigating an input box).

`Static` `Readonly`MoveEdgeRight

MoveEdgeRight = 4

Input was moved to the right over an edge (for example for navigating an input box).

`Static` `Readonly`MoveEdgeUp

MoveEdgeUp = 13

Input was moved to the up edge (for example for navigating an input box).

`Static` `Readonly`MoveLeft

MoveLeft = 5

Input was moved left (for example for navigating an input box).

`Static` `Readonly`MovePageDown

MovePageDown = 10

Input was moved one page down (i.e. page-down key as been pressed).

`Static` `Readonly`MovePageUp

MovePageUp = 9

Input was moved one page up (i.e. page-up key as been pressed).

`Static` `Readonly`MoveRight

MoveRight = 6

Input was moved right (for example for navigating an input box).

`Static` `Readonly`MoveUp

MoveUp = 7

Input was moved up (for example for navigating an input box).

`Static` `Readonly`MoveWordLeft

MoveWordLeft = 11

Input was moved a word to the left (for example for navigating an input box).

`Static` `Readonly`MoveWordRight

MoveWordRight = 12

Input was moved a word to the right (for example for navigating an input box).

`Static` `Readonly`Redraw

Redraw = 0

UI system is forcing the UI element to redraw itself.

`Static` `Readonly`Return

Return = 33

Shift + Enter was pressed.

`Static` `Readonly`SelectDown

SelectDown = 24

Input selection was moved down (for example for selecting text in an input box).

`Static` `Readonly`SelectEdgeDown

SelectEdgeDown = 18

Input selection was moved an edge down direction (for example for selecting text in an input box).

`Static` `Readonly`SelectEdgeLeft

SelectEdgeLeft = 19

Input selection was moved an edge left direction (for example for selecting text in an input box).

`Static` `Readonly`SelectEdgeRight

SelectEdgeRight = 20

Input selection was moved an edge right direction (for example for selecting text in an input box).

`Static` `Readonly`SelectEdgeUp

SelectEdgeUp = 17

Input selection was moved an edge up direction (for example for selecting text in an input box).

`Static` `Readonly`SelectLeft

SelectLeft = 21

Input selection was moved left (for example for selecting text in an input box).

`Static` `Readonly`SelectLineEnd

SelectLineEnd = 26

Input selection was moved to the end of the line.

`Static` `Readonly`SelectLineStart

SelectLineStart = 25

Input selection was moved to the start of the line.

`Static` `Readonly`SelectPageDown

SelectPageDown = 28

Input selection was moved one page down (i.e. page-down key as been pressed).

`Static` `Readonly`SelectPageUp

SelectPageUp = 27

Input selection was moved one page up (i.e. page-up key as been pressed).

`Static` `Readonly`SelectRight

SelectRight = 22

Input selection was moved right (for example for selecting text in an input box).

`Static` `Readonly`SelectUp

SelectUp = 23

Input selection was moved up (for example for selecting text in an input box).

`Static` `Readonly`SelectWordLeft

SelectWordLeft = 15

Input selection was moved a word to the left direction (for example for selecting text in an input box).

`Static` `Readonly`SelectWordRight

SelectWordRight = 16

Input selection was moved a word to the right direction (for example for selecting text in an input box).

`Static` `Readonly`Tab

Tab = 35

Tab key was pressed.

`Static` `Readonly`TabBackwards

TabBackwards = 36

Shift + Tab key was pressed.

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration UICommandEventType

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns UICommandEventType

Values

Static ReadonlyBackspace

Static ReadonlyConfirm

Static ReadonlyDelete

Static ReadonlyEscape

Static ReadonlyFocusGained

Static ReadonlyFocusLost

Static ReadonlyInsert

Static ReadonlyMoveDown

Static ReadonlyMoveEdgeDown

Static ReadonlyMoveEdgeLeft

Static ReadonlyMoveEdgeRight

Static ReadonlyMoveEdgeUp

Static ReadonlyMoveLeft

Static ReadonlyMovePageDown

Static ReadonlyMovePageUp

Static ReadonlyMoveRight

Static ReadonlyMoveUp

Static ReadonlyMoveWordLeft

Static ReadonlyMoveWordRight

Static ReadonlyRedraw

Static ReadonlyReturn

Static ReadonlySelectDown

Static ReadonlySelectEdgeDown

Static ReadonlySelectEdgeLeft

Static ReadonlySelectEdgeRight

Static ReadonlySelectEdgeUp

Static ReadonlySelectLeft

Static ReadonlySelectLineEnd

Static ReadonlySelectLineStart

Static ReadonlySelectPageDown

Static ReadonlySelectPageUp

Static ReadonlySelectRight

Static ReadonlySelectUp

Static ReadonlySelectWordLeft

Static ReadonlySelectWordRight

Static ReadonlyTab

Static ReadonlyTabBackwards

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

`Protected`constructor

`Static` `Readonly`Backspace

`Static` `Readonly`Confirm

`Static` `Readonly`Delete

`Static` `Readonly`Escape

`Static` `Readonly`FocusGained

`Static` `Readonly`FocusLost

`Static` `Readonly`Insert

`Static` `Readonly`MoveDown

`Static` `Readonly`MoveEdgeDown

`Static` `Readonly`MoveEdgeLeft

`Static` `Readonly`MoveEdgeRight

`Static` `Readonly`MoveEdgeUp

`Static` `Readonly`MoveLeft

`Static` `Readonly`MovePageDown

`Static` `Readonly`MovePageUp

`Static` `Readonly`MoveRight

`Static` `Readonly`MoveUp

`Static` `Readonly`MoveWordLeft

`Static` `Readonly`MoveWordRight

`Static` `Readonly`Redraw

`Static` `Readonly`Return

`Static` `Readonly`SelectDown

`Static` `Readonly`SelectEdgeDown

`Static` `Readonly`SelectEdgeLeft

`Static` `Readonly`SelectEdgeRight

`Static` `Readonly`SelectEdgeUp

`Static` `Readonly`SelectLeft

`Static` `Readonly`SelectLineEnd

`Static` `Readonly`SelectLineStart

`Static` `Readonly`SelectPageDown

`Static` `Readonly`SelectPageUp

`Static` `Readonly`SelectRight

`Static` `Readonly`SelectUp

`Static` `Readonly`SelectWordLeft

`Static` `Readonly`SelectWordRight

`Static` `Readonly`Tab

`Static` `Readonly`TabBackwards

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags