Language Reference Guide > Language Reference Guide > System Classes > InputEvent Class > EventKey Method
Was this helpful?
EventKey Method
The EventKey method creates a lookup key used to store (or access) a response to an event.
You use event keys as lookup keys to predefine the event response objects (agents) that, when applied, will produce a particular behavior. When OpenROAD subsequently responds to input events, it creates the corresponding event key internally and uses it to find and apply any responses you have predefined.
Sprite keys are a subset of event keys, used specifically for sprite-related responses. For sprite-specific keys, see SpriteDescriptor SpriteKey Method.
The key has the format: action_modifierkey_responsecode
This method has the following syntax:
varchar(32) = InputEvent.EventKey(action = integer,
          modifierkey = integer, responsecode = integer)
This method has the following parameters:
action
(Required) Specifies the action to be responded to. Valid system-defined actions are:
IE_LMOUSEDBLCLK
IE_LMOUSEDOWN
IE_LMOUSEUP
IE_MMOUSEDBLCLK
IE_MMOUSEDOWN
IE_MMOUSEUP
IE_MOUSEENTER
IE_MOUSEEXIT
IE_MOUSEHOVER
IE_MOUSEMOVE
IE_PULSE
IE_RMOUSEDBLCLK
IE_RMOUSEDOWN
IE_RMOUSEUP
IE_TICKPOINT
IE_USER
For more information about system constants for these values, see Input Event Settings.
modifierkey
(Required) Specifies the key or keycombination pressed during the action. Valid values are:
KB_NONE
KB_SHIFT
KB_CONTROL
KB_ALT
KB_SHIFT_LEFT
KB_SHIFT_RIGHT
KB_CONTROL_LEFT
KB_CONTROL_RIGHT
KB_ALT_LEFT
KB_ALT_RIGHT
KB_ESCAPE
KB_FUNCTION
KB_LOGO
For more information about system constants for these values, see Key State Settings.
responsecode
(Required) Specifies which system-defined or user-defined responsecode to use.
Responsecodes identify particular event-response behaviors. Examples of such behaviors are value-check, image-pulse, animation, flyover, highlight, drag, dropdown.
User-defined behaviors must use values greater than 100.
Valid system-defined values are:
RE_ANIMATE
RE_DRAG
RE_MOVE
RE_PULSE
RE_USERDEFAULT
RSP_DROPMENU
RSP_DROPCHOICE
RSP_HIGHLIGHT
RSP_HOTCURSOR
For more information about system constants for these values, see Response Settings.
The method returns the event key.
Last modified date: 12/20/2023