UserInterfaceGeneralEvent.add Method

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

Description

Add a handler to be notified when the event occurs.

Syntax

"userInterfaceGeneralEvent_var" is a variable referencing a UserInterfaceGeneralEvent object.
returnValue = userInterfaceGeneralEvent_var.add(handler)
"userInterfaceGeneralEvent_var" is a variable referencing a UserInterfaceGeneralEvent object.

#include <Core/UserInterface/UserInterfaceGeneralEvent.h>

returnValue = userInterfaceGeneralEvent_var->add(handler);

Return Value

Type Description
boolean Returns true if the addition of the handler was successful.

Parameters

Name Type Description
handler UserInterfaceGeneralEventHandler The handler object to be called when this event is fired.

Version

Introduced in version March 2017