KeyboardEventArgs Object

Derived from: EventArgs Object
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/KeyboardEventArgs.h>

Description

Provides a set of arguments from a firing KeyboardEvent to a KeyboardEventHandler's notify callback method.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

Properties

Name Description
firingEvent The event that the firing is in response to.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
keyCode Gets the keyboard key.
modifierMask Gets the set of keyboard modifiers that were active. The value is the Boolean combination of KeyboardModifiers values.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Version

Introduced in version August 2014