Legacy Document

Inside Macintosh: Text /

Chapter 7 - Text Services Manager / Text Services Manager Reference

Text Services Manager Routines for Client Applications / Requesting a Floating Input Window

UseInputWindow

The UseInputWindow function associates a floating input window with a particular TSM document or with all TSM documents of an application.

FUNCTION UseInputWindow (idocID: TSMDocumentID; 
                         useWindow: Boolean): OSErr;

idocID

The TSM document ID of the particular TSM document to be associated with the floating input window. If NIL, this call affects all your application's TSM documents.

useWindow

A Boolean value that indicates whether to use the floating input window. Set it to TRUE if you want to use a floating window; set it to FALSE if you do not want to use a floating window.

DESCRIPTION

The Text Services Manager provides a floating input window for your application's use if you call UseInputWindow with a value of TRUE in the useWindow parameter. To specify inline input instead, call UseInputWindow with a value of FALSE in the useWindow parameter.

The default value for useWindow is FALSE; if you do not call UseInputWindow, the Text Services Manager assumes that your application wants to use inline input. If your application wants to save the user's choice, it can put the last-used value for useWindow in a preferences file before quitting.

If you pass a valid TSM document ID for the idocID parameter, the useWindow parameter affects only that TSM document. If you pass NIL for the idocID parameter, the useWindow parameter affects all your application's TSM documents, including documents you create after making this call.

RESULT CODES

noErr	No error
tsmInvalidDocIDErr	The document is not a valid TSM document
tsmNeverRegisteredErr	Application is not TSM-aware