Carbon


UseInputWindow

Header: TextServices.h Carbon status: Supported

Associates a floating input window with a particular TSM document or with all TSM documents of an application.

OSErr UseInputWindow (
    TSMDocumentID idocID, 
    Boolean useWindow
);
Parameter descriptions
idocID

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

useWindow

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.

function result

A result code.

DISCUSSION

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 NULL for the idocID parameter, the useWindow parameter affects all your application’s TSM documents, including documents you create after making this call.

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)