MouseEvent.remove Method

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

Description

Removes a handler from this event endpoint.

Syntax

"mouseEvent_var" is a variable referencing a MouseEvent object.
returnValue = mouseEvent_var.remove(handler)
"mouseEvent_var" is a variable referencing a MouseEvent object.

#include <Core/UserInterface/MouseEvent.h>

returnValue = mouseEvent_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 MouseEventHandler A MouseEventhandler that was previously added to this event with the add method.

Version

Introduced in version August 2014