Carbon


TSMEvent

Header: TextServices.h Carbon status: Unsupported

Passes all events obtained from the WaitNextEvent function, including null events, to the Text Services Manager.

Boolean TSMEvent (
    EventRecord *event
);
Parameter descriptions
event

A pointer to the event structure for the event that has been obtained from WaitNextEvent.

function result

If FALSE, you need to process the event as you normally do. If TRUE, the event has been handled by a text service component and is now a null event. You should process the null event as you normally do.

DISCUSSION

Your client application regularly obtains events such as key-down events from the Toolbox Event Manager function WaitNextEvent. Some of these events may need to be handled by text service components. The TSMEvent function lets you pass those events to the Text Services Manager. The Text Services Manager dispatches the passed events to the appropriate text service components by calling the TextServiceEvent function for each component.

The way the Text Services Manager uses and dispatches Apple events creates the potential for a reentrance situation that your client application should know about and be prepared to handle. When your application calls TSMEvent, the Text Services Manager uses the Apple Event Manager function AESend to pass data to your application through an Apple event. Your Apple event handler is thus invoked before the TSMEvent trap has returned.

AVAILABILITY

Not supported in Carbon. Not available in Carbon.

CARBON NOTES

Not needed in Mac OS X due to the new event model.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)