Showing or Hiding the Floating Input Window(IM: Tx)

Chapter 7 - Text Services Manager / Text Services Manager Reference

Apple Event Handlers Supplied by Client Applications

Showing or Hiding the Floating Input Window
Input methods that supply floating input windows for bottomline input may need to show or hide the input window at various times. The Show/Hide Input Window Apple event requests the client application to make the floating input window either visible or not visible, so that an input method can offer any of the above options.

Note
If your application is not displaying its own floating input window, you can ignore this Apple event.
Show/Hide Input Window--Showing or Hiding the Floating Input Window (Continued)
Event class kTextServiceClass
Event ID kShowHideInputWindow
Requested action Make the bottomline floating input window either visible or not visible, depending on the value of the keyAEShowHideInputWindow parameter.

Required parameters
Keyword: keyAETSMDocumentRefcon
Descriptor type: typeLongInteger
Data: A TSM document specifier (reference constant) supplied by the application in a prior call to the NewTSMDocument function (see page 7-50). This value is associated with the TSM document for the window being shown or hidden.
Keyword: keyAEServerInstance
Descriptor type: typeComponentInstance
Data: A component instance value returned by a prior call to the Component Manager OpenComponent function. This value identifies the text service component.
Optional parameter
Keyword: keyAEShowHideInputWindow
Descriptor type: typeBoolean
Data: If TRUE, the bottomline input window should be shown; if FALSE, it should be hidden. This parameter is not needed if the input method is simply inquiring about the state of the input window.
Return parameter
Keyword: keyAEShowHideInputWindow
Descriptor type: typeBoolean
Data: The current state of the input window: TRUE if the window is shown; FALSE if it is hidden. If the optional parameter keyAEShowHideInputWindow is included, this return parameter should show the state of the window before it was set to the state requested in the optional parameter.

Show/Hide Input Window--Showing or Hiding the Floating Input Window (Continued)
Event class	kTextServiceClass
Event ID	kShowHideInputWindow
Requested action	Make the bottomline floating input window either visible or not visible, depending on the value of the `keyAEShowHideInputWindow` parameter.

Required parameters
Keyword:	keyAETSMDocumentRefcon
Descriptor type:	typeLongInteger
Data:	A TSM document specifier (reference constant) supplied by the application in a prior call to the `NewTSMDocument` function (see page 7-50). This value is associated with the TSM document for the window being shown or hidden.
Keyword:	keyAEServerInstance
Descriptor type:	typeComponentInstance
Data:	A component instance value returned by a prior call to the Component Manager `OpenComponent` function. This value identifies the text service component.
Optional parameter
Keyword:	keyAEShowHideInputWindow
Descriptor type:	typeBoolean
Data:	If `TRUE`, the bottomline input window should be shown; if `FALSE`, it should be hidden. This parameter is not needed if the input method is simply inquiring about the state of the input window.
Return parameter
Keyword:	keyAEShowHideInputWindow
Descriptor type:	typeBoolean
Data:	The current state of the input window: `TRUE` if the window is shown; `FALSE` if it is hidden. If the optional parameter `keyAEShowHideInputWindow` is included, this return parameter should show the state of the window before it was set to the state requested in the optional parameter.