Carbon


HidePaletteWindows

Header: TextServices.h Carbon status: Supported

Instructs an input method to hide its floating windows because another input method is becoming active.

ComponentResult HidePaletteWindows (
    ComponentInstance ts
);
Parameter descriptions
ts

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

function result

If the text service component has no palettes, it should return a ComponentResult value of noErr.

DISCUSSION

If you are writing a text service component, it must implement a function for this call.

The HidePaletteWindows function is not called every time a component’s document becomes inactive; it is called by the Text Services Manager only if the new document that is becoming active does not use the same text service component as the document last deactivated. When it receives a HidePaletteWindows call, the text service component should hide all its floating and nonfloating windows. Its menus, if any, will be removed from the menu bar by the Text Services Manager.

The Text Services Manager makes this call either on its own or in response to application-interface calls it receives from client applications.

Client applications also may make this call, but the Text Services Manager does not play a role in the connection between the client application making the call and the text service component receiving it. If you are an application making this call, you need to know the component instance of the component whose function you are calling.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


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