TonCut

Events

This page covers INotifyEventHandler, INotifyEvent, IIdChangeEventHandler, and IIdChangeEvent. More specialized change-event interfaces follow the same add/remove/invoke pattern and are documented on their own domain pages.

Interfaces

INotifyEventHandler

Callback sink that can be registered on the matching event interface.

Source: SDK/include/pascal/uINotifyEvent.pas

Methods

Method name
Invoke()
Type
procedure
Description
Handle the event callback when the owning event interface invokes it.
Declaration
procedure Invoke(aSender: IUnknown); safecall;
Published SDK declaration languages: Pascal.
Parameters
aSender
IUnknown
Object that raised the event.

INotifyEvent

Generic event interface following the Add, Remove, and Invoke pattern used throughout the Desktop API.

Source: SDK/include/pascal/uINotifyEvent.pas

Methods

Method name
Add()
Type
procedure
Description
Add an item or handler.
Declaration
procedure Add(aHandler: INotifyEventHandler); safecall;
Published SDK declaration languages: Pascal.
Parameters
aHandler
INotifyEventHandler
The handler interface instance to use.
Method name
Remove()
Type
procedure
Description
Remove an item or handler.
Declaration
procedure Remove(aHandler: INotifyEventHandler); safecall;
Published SDK declaration languages: Pascal.
Parameters
aHandler
INotifyEventHandler
The handler interface instance to use.
Method name
Invoke()
Type
procedure
Description
Raise the event for the current payload.
Declaration
procedure Invoke(aSender: IUnknown); safecall;
Published SDK declaration languages: Pascal.
Parameters
aSender
IUnknown
Object that raised the event.

IIdChangeEventHandler

Callback sink consumed by the matching change-event interface.

Source: SDK/include/pascal/uIIdChangeEvent.pas

Methods

Method name
Invoke()
Type
procedure
Description
Handle the event callback when the owning event interface invokes it.
Declaration
procedure Invoke(aSender: IUnknown; aNewId: Int64; aOldId: Int64); safecall;
Published SDK declaration languages: Pascal.
Parameters
aSender
IUnknown
Object that raised the event.
aNewId
Int64
New TonCut object identifier.
aOldId
Int64
Previous TonCut object identifier.

IIdChangeEvent

Event interface with Add, Remove, and Invoke hooks for collection or entity change notifications.

Source: SDK/include/pascal/uIIdChangeEvent.pas

Methods

Method name
Add()
Type
procedure
Description
Add an item or handler.
Declaration
procedure Add(aHandler: IIdChangeEventHandler); safecall;
Published SDK declaration languages: Pascal.
Parameters
aHandler
IIdChangeEventHandler
The handler interface instance to use.
Method name
Remove()
Type
procedure
Description
Remove an item or handler.
Declaration
procedure Remove(aHandler: IIdChangeEventHandler); safecall;
Published SDK declaration languages: Pascal.
Parameters
aHandler
IIdChangeEventHandler
The handler interface instance to use.
Method name
Invoke()
Type
procedure
Description
Raise the typed change event for the current payload.
Declaration
procedure Invoke(aSender: IUnknown; aNewId: Int64; aOldId: Int64); safecall;
Published SDK declaration languages: Pascal.
Parameters
aSender
IUnknown
Object that raised the event.
aNewId
Int64
Event payload field for new id.
aOldId
Int64
Event payload field for old id.