Edit

ITfFnGetPreferredTouchKeyboardLayout interface (ctffunc.h)

  • Article

The ITfFnGetPreferredTouchKeyboardLayout interface is implemented by a text service to specify the use of a particular keyboard layout supported by the inbox Windows 8 touch keyboard.

When an IME is active the touch keyboard will use ITfFunctionProvider::GetFunction with IID_ITfFnGetPreferredTouchKeyboardLayout to query the IME for this function.

If the function is not supported by the IME, then the touch keyboard will show the default layout for the language.

Inheritance

The ITfFnGetPreferredTouchKeyboardLayout interface inherits from ITfFunction. ITfFnGetPreferredTouchKeyboardLayout also has these types of members:

Methods

The ITfFnGetPreferredTouchKeyboardLayout interface has these methods.

 
ITfFnGetPreferredTouchKeyboardLayout::GetLayout

Obtains the touch keyboard layout identifier of the layout that the IME directs the touch keyboard to show while the IME is active.

Remarks

For more information on the layouts which can be specified, see GetLayout.

This interface applies only to IMEs written using the Text Services Framework and not to legacy IMM32 IMEs, and it only applies to the following input languages:

  • Japanese
  • Korean
  • Simplified Chinese
  • Traditional Chinese

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header ctffunc.h

See also

ITfFunction