KeyboardEvent.remove Method

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

Description

Removes a handler from this event endpoint.

Syntax

"keyboardEvent_var" is a variable referencing a KeyboardEvent object.
returnValue = keyboardEvent_var.remove(handler)
"keyboardEvent_var" is a variable referencing a KeyboardEvent object.

#include <Core/UserInterface/KeyboardEvent.h>

returnValue = keyboardEvent_var->remove(handler);

Return Value

Type Description
boolean Returns true if the handler was found and removed from the set of event handlers.

Parameters

Name Type Description
handler KeyboardEventHandler A KeyboardEventHandler that was previously added to this event with the add method.

Version

Introduced in version August 2014