DrawState (SUI)

Describes an input state at the time of the triggering  ScriptUIGraphics.onDraw() event.

Contains properties that report whether the current control has the input focus, and the particular mouse button and keypress state. Passed in as argument to ScriptUIGraphics.onDraw().

Objects:

Boolean

Property Listing

Property

Type

Access

Description

altKeyPressed

Boolean

readonly

True if the Alt key is being pressed (in Windows only).

capsLockKeyPressed

Boolean

readonly

True if the Caps Lock key is being pressed.

cmdKeyPressed

Boolean

readonly

True if the Command key is being pressed (in Mac OS only).

ctrlKeyPressed

Boolean

readonly

True if the Ctrl key is being pressed.

hasFocus

Boolean

readonly

True if the element has the input focus.

leftButtonPressed

Boolean

readonly

True if the left mouse button is being pressed.

middleButtonPressed

Boolean

readonly

True if the middle mouse button is being pressed.

mouseOver

Boolean

readonly

True if the cursor is hovering over this element.

numLockKeyPressed

Boolean

readonly

True if the Num Lock key is being pressed.

optKeyPressed

Boolean

readonly

True if the Option key is being pressed (in Mac OS only).

rightButtonPressed

Boolean

readonly

True if the right mouse button is being pressed.

shiftKeyPressed

Boolean

readonly

True if the Shift key is being pressed.