Legacy Document

Inside Macintosh: Text /

Chapter 7 - Text Services Manager / Text Services Manager Reference

Text Service Component Routines / Responding to Events and Updating the Cursor and Menu

GetTextServiceMenu

The GetTextServiceMenu function returns a handle to a menu belonging to a text service component.

FUNCTION GetTextServiceMenu (ts: ComponentInstance; 
                             VAR serviceMenu: MenuHandle): 
                             ComponentResult;

ts

A component instance created by a prior call to the Component Manager OpenComponent function.

serviceMenu

A menu handle (defined by the Menu Manager MenuHandle data type) for the text service component that is to be updated.

DESCRIPTION

The Text Services Manager calls GetTextServiceMenu to a text service component when the component is opened or activated, so that it can put the component's menu on the menu bar.

The menu handle passed in serviceMenu may be preallocated or it may be NIL. If
the menu handle is NIL, the text service component should allocate a new menu and return it.

Note

All instances of an input-method component must share a single menu handle, allocated in the system heap.

If the text service component does not have a menu, it should return a ComponentResult value of TSMHasNoMenuErr.