Xojo Conferences

Platforms to show: All Mac Windows Linux Cross-Platform

TextInputSourceMBS class

Type Topic Plugin Version macOS Windows Linux Console & Web iOS
class Mac MBS MacOSX Plugin 12.5 Yes No No Yes, macOS only No
Function: The class for text input source on Mac OS X.
Text input sources fall into three general categories:

  • Keyboard input sources, including keyboard layouts, keyboard input methods and input modes
  • Palette input sources, including the character palette, keyboard viewer, and private dictionary panels
  • Ink input sources

Palette input sources and ink input source are categorized as non-keyboard input sources. However, palette input sources might still involve some keyboard interaction. Keyboard input methods can be mode-enabled (for instance, Kotoeri). Hence, they are potentially the parent of several input modes directly selectable in the user interface (for instance, hiragana, katakana, and romaji). With mode-enabled input methods, the parent input method is not directly selectable. Non-mode-enabled input methods are directly selectable.

Some input sources are provided and installed with OS X. Other input sources can be installed as third party products themselves or as part of the installation of certain applications. International Preferences displays a list of all visible installed input sources. You can use International Preferences to enable or disable most input sources that are intended to be visible in the user interface. Setup Assistant also enables some input sources. A separate user interface provides a way to enable ink input sources.

You can use some of the functions in Text Input Source Services to enable or disable input sources programmatically in your application. One keyboard input source must be enabled. Only one ink input source may be enabled. Multiple instances of other input source types may be enabled.

Some enabled input sources are invisible but programmatically selectable, such as ink. Some are visible but not programmatically selectable, such as mode-savvy parent input methods (these must be visible so that International Preferences can display the parent input method for a group of input modes).

Input modes can only be changed from disabled to enabled if their parent input method is enabled. Input modes can only be selected if they and their parent input method are enabled.

Exactly one keyboard input source is selected at any time: the current keyboard input source. Selecting a new keyboard input source deselects the previous keyboard input source. Multiple palette input sources may be selected. For instance, there may be one or more character palettes and one or more keyboard viewers selected in addition to the selected keyboard input source. Selecting or deselecting a palette (or ink) input source does not affect any other input source. Input methods that provide associated input palettes may programmatically deselect the palette when the input method is deselected, for example.

Text Input Source Source Services specifies modern, non-Script-Manager-based programming interfaces for operating on text input sources and performs the following functions:

  • Finds information about text input sources
  • Selects, enables, and disables text input sources
  • Receives notifications about relevant changes in text input sources.

Available in OS X v10.5 and later.

see also

Feedback, Comments & Corrections

This class has no sub classes.

Some examples which use this class:

Blog Entries

The items on this page are in the following plugins: MBS MacOSX Plugin.

TextField   -   TidyAttributeMBS

The biggest plugin in space...

MBS Xojo Plugins