Dispatch

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODDispatchModule

Dispatch
The Dispatch method should dispatch the specified event to the appropriate part.
ODBoolean Dispatch (inout ODEventData event,
                    inout eventinfo eventinfo);
event
A platform-specific structure representing an event. On return, the fields of the structure may have been modified. On the Mac OS platform, the structure is defined as a Mac OS event record.
eventInfo
A platform-specific structure that contains additional event information. On return, the relevant fields of the structure are filled in if the event was handled.
return value
kODTrue if the event was handled by a part, otherwise kODFalse.

DISCUSSION
The eventInfo structure contains the following information:

a reference to an embedded frame and an embedded facet of the part (for event types kODEvtMouseDownEmbedded, kODEvtMouseUpEmbedded, or kODEvtMouseDownBorder)
an ODPoint value describing the location of the event, expressed in frame coordinates
a Boolean value that indicates whether an embedded part propagated an event to its containing part

OpenDoc calls this method after it has located this dispatch module in its dispatch module dictionary. This method in turn calls the part's HandleEvent method to give the part the opportunity to handle the specified event.

OVERRIDING
If you subclass ODDispatchModule, you must override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely.

SEE ALSO
The ODEventData type (page 890).
The ODEventInfo type (page 891).
The ODDispatcher::Dispatch method (page 115).
The ODPart::HandleEvent method (page 526).
"Creating a Dispatch Module" on page 447 in OpenDoc Programmer's Guide.