Manager: Text Services Manager


Carbon supports nearly all Text Services Manager functions. The exceptions are those functions, such as NewServiceWindow and CloseServiceWindow, used to create and manage floating utility windows. If you have a TSM component that uses floating utility windows, you should replace these functions with equivalent Carbon-compliant Window Manager functions, which offer more complete support for creating and managing floating windows.

For example, instead of the NewServiceWindow function, you can use the Window Manager function CreateNewWindow, and specify either kFloatingWindowClass or kUtilityWindowClass.

Likewise, use DisposeWindow instead of CloseServiceWindow, GetFrontWindowOfClass instead of GetFrontServiceWindow, and FindWindowOfClass instead of FindServiceWindow.

Finally, the TSMEvent, TSMMenuSelect, and SetTSMCursor functions no longer need to be called, so they are not included in Carbon.

Supported  ActivateTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  ActivateTSMDocument

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  CloseServiceWindow

Carbon text service components should use the Carbon Window Manager functions for working with utility windows, rather than the Text Service Manager service window calls. Not available in CarbonLib. Not available in Mac OS X.

Supported  CloseTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  CloseTSMAwareApplication

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

Supported  DeactivateTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  DeactivateTSMDocument

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  DeleteTSMDocument

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  FindServiceWindow

Carbon text service components should use the Carbon Window Manager functions for working with utility windows, rather than the Text Service Manager service window calls. Not available in CarbonLib. Not available in Mac OS X.

Supported  FixTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  FixTSMDocument

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  GetDefaultInputMethod

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  GetFrontServiceWindow

Carbon text service components should use the Carbon Window Manager functions for working with utility windows, rather than the Text Service Manager service window calls. Not available in CarbonLib. Not available in Mac OS X.

Supported  GetScriptLanguageSupport

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  GetServiceList

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  GetTextServiceLanguage

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  GetTextServiceMenu

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  GetTextServiceProperty

Available in CarbonLib 1.0 and later. Available in Mac OS X 10.0 and later.

Supported  HidePaletteWindows

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  InitiateTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  InitTSMAwareApplication

Carbon applications are automatically considered TSM-aware and therefore have no need to call this function. Not available in CarbonLib. Not available in Mac OS X.

Unsupported  NewCServiceWindow

Replace calls to NewCServiceWindow in your component with calls to Mac OS 8.5 Window Manager creation functions, such as CreateNewWindow, which offer more complete support for floating windows. Not available in CarbonLib. Not available in Mac OS X.

Unsupported  NewServiceWindow

Carbon text service components should use the Window Manager function CreateNewWindow (of class kUtilityWindowClass), rather than this call. Not available in CarbonLib. Not available in Mac OS X.

Supported  NewTSMDocument

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  OpenTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  SendAEFromTSMComponent

Note that this function is superseded by the function SendTextInputEvent on Mac OS X only. With Mac OS X, text service components must be Carbon clients. This is in contrast to Mac OS 8 and 9, where text service components must not be Carbon clients. (This restriction is due to the fact that it is potentially destabilizing for a Carbon-based component to load Carbon in the context of a non-Carbon application.) Therefore, text service components use Carbon text input events and the SendTextInputEvent function only on Mac OS X. The function SendAEFromTSMComponent must be used by components running on Mac OS 8 and 9.

On any system, the Text Services Manager automatically converts component-originated text input events to the proper form for client applications. On Mac OS X, the Text Services Manager automatically converts component-originated Carbon events to Apple events, if a client application does not provide handlers for Carbon events. Conversely, on Mac OS 8 and 9, the Text Services Manager automatically converts component-originated Apple events to Carbon events and provides these Carbon events to applications, so they have the option of handling them. Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  SendTextInputEvent

Note that this function replaces the function SendAEFromTSMComponent on Mac OS X only. With Mac OS X, text service components must be Carbon clients. This is in contrast to Mac OS 8 and 9, where text service components must not be Carbon clients. (This restriction is due to the fact that it is potentially destabilizing for a Carbon-based component to load Carbon in the context of a non-Carbon application.) Therefore, text service components use Carbon text input events and the SendTextInputEvent function only on Mac OS X. The function SendAEFromTSMComponent must be used by components running on Mac OS 8 and 9.

On any system, the Text Services Manager automatically converts component-originated text input events to the proper form for client applications. On Mac OS X, the Text Services Manager automatically converts component-originated Carbon events to Apple events, if a client application does not provide handlers for Carbon events. Conversely, on Mac OS 8 and 9, the Text Services Manager automatically converts component-originated Apple events to Carbon events and provides these Carbon events to applications, so they have the option of handling them. Not available in CarbonLib. Available in Mac OS X 10.0 and later.

Supported  SetDefaultInputMethod

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  SetTextServiceCursor

Not available in CarbonLib. Not available in Mac OS X.

Supported  SetTextServiceLanguage

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Supported  SetTextServiceProperty

Available in CarbonLib 1.0 and later. Available in Mac OS X 10.0 and later.

Unsupported  SetTSMCursor

Carbon applications should use the function TSMSetInlineInputRegion instead of the SetTSMCursor function. Not available in CarbonLib. Not available in Mac OS X.

Supported  TerminateTextService

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

Unsupported  TextServiceEvent

Carbon programs must use the function TextServiceEventRef rather than this call. Not available in CarbonLib. Not available in Mac OS X.

Supported  TextServiceEventRef

Carbon programs sending events directly to text service components, bypassing the Text Services Manager, must use the TextServiceEventRef function rather than the TextServiceEvent call. On the Mac OS 8 and 9 platform, where text service components cannot be Carbon based and therefore cannot implement this call, the Text Services Manager provides an implementation of the TextServiceEventRef function that in turn calls the TextServiceEvent or UCTextServiceEvent functions as appropriate. Available in CarbonLib 1.1 and later. Available in Mac OS X 10.0 and later.

Unsupported  TextServiceMenuSelect

Not available in CarbonLib. Not available in Mac OS X.

Unsupported  TSMEvent

Carbon applications do not need to pass events to the Text Services Manager. Not available in CarbonLib. Not available in Mac OS X.

Supported  TSMGetActiveDocument

Available in CarbonLib 1.3 and later. Available in Mac OS X 10.0 and later.

Unsupported  TSMMenuSelect

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

Supported  TSMSetInlineInputRegion

The TSMSetInlineInputRegion function replaces the function SetTSMCursor for Carbon applications. Available in CarbonLib 1.1 and later. Available in Mac OS X 10.0 and later.

Unsupported  UCTextServiceEvent

Carbon programs must use the function TextServiceEventRef rather than this call. Not available in CarbonLib. Not available in Mac OS X.

Unsupported  UCTextServiceEventRef

This function isn't useful.

Supported  UseInputWindow

Available in CarbonLib 1.0 and later when running Mac OS 8.1 or later. Available in Mac OS X 10.0 and later.

[Table of Contents] [Manager Index] [Function Index]

Generated on: 12/12/2001. Copyright © 1999-2001 Apple Computer, Inc. All rights reserved.