Command.keyDown Event

Parent Object: Command
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/Command.h>

Description

Gets an event that is fired when a key on the keyboard is pressed down.

Syntax

-------- Import ---------
# Import fusion360utils folder, which includes event_utils.py.
from ...lib import fusion360utils as futil

-------- Global variables ---------
# Global variable used to maintain a reference to all event handlers.
local_handlers = []

-------- Connect the handler to the event. ---------
# "command_var" is a variable referencing a Command object.
# "command_keyDown" is the event handler function.
futil.add_handler(command_var.keyDown, command_keyDown, local_handlers=local_handlers)

-------- Event handler function definition ---------
# Event handler for the keyDown event.
def command_keyDown(args: adsk.core.KeyboardEventArgs):
# Code to react to the event.
app.log('In command_keyDown event handler.')
-------- Global variables ---------
# Global variable used to maintain a reference to all event handlers.
handlers = []

-------- Connect the handler to the event. ---------
# "command_var" is a variable referencing a Command object.
# "MyKeyDownHandler" is the name of the class that handles the event.
onKeyDown = MyKeyDownHandler()
command_var.keyDown.add(onKeyDown)
handlers.append(onKeyDown)

-------- Event handler class definition ---------
# Event handler for the keyDown event.
class MyKeyDownHandler(adsk.core.KeyboardEventHandler):
def __init__(self):
super().__init__()
def notify(self, args: adsk.core.KeyboardEventArgs):
# Code to react to the event.
app.log('In MyKeyDownHandler event handler.')
--------- Required include files. ---------
#include <Core/UserInterface/Command.h>
#include <Core/UserInterface/KeyboardEvent.h>
#include <Core/UserInterface/KeyboardEventHandler.h>
#include <Core/UserInterface/KeyboardEventArgs.h>


--------- Event handler class definition and global declaration. ---------
// Event handler for the keyDown event.
class MyKeyDownEventHandler : public adsk::core::KeyboardEventHandler
{
public:
void notify(const Ptr<KeyboardEventArgs>& eventArgs) override
{
// Code to react to the event.
ui->messageBox("In MyKeyDownEventHandler event handler.");
}
} _keyDown;

--------- Connect the handler to the event. ---------
// "command_var" is a variable referencing a Command object.
// Connect the handler function to the event.
Ptr<KeyboardEvent> keyDownEvent = command_var->keyDown();
if (!keyDownEvent)
return;

bool isOk = keyDownEvent->add(&_keyDown);
if (!isOk)
return;

Property Value

This is an event property that returns a KeyboardEvent.

Version

Introduced in version August 2014