Platforms to show: All Mac Windows Linux Cross-Platform

Back to TextInputSourceMBS class.

Previous items

TextInputSourceMBS.kTISTypeInk as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the possible type values.

This type belongs to the category kTISCategoryInkInputSource. Even though it is the only type in that category, a type is provided so that clients who don't need category information can just check input source type.

TextInputSourceMBS.kTISTypeKeyboardInputMethodModeEnabled as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the possible type values.

This type belongs to the category kTISCategoryKeyboardInputSource.

TextInputSourceMBS.kTISTypeKeyboardInputMethodWithoutModes as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the possible type values.

This type belongs to the category kTISCategoryKeyboardInputSource.

TextInputSourceMBS.kTISTypeKeyboardInputMode as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the possible type values.

This type belongs to the category kTISCategoryKeyboardInputSource.

TextInputSourceMBS.kTISTypeKeyboardLayout as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the possible type values.

This type belongs to the category kTISCategoryKeyboardInputSource.

TextInputSourceMBS.kTISTypeKeyboardViewer as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the possible type values.

This type belongs to the category kTISCategoryPaletteInputSource.

TextInputSourceMBS.RegisterInputSource(file as folderitem) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Registers any new input sources in a file or bundle so a text input source reference can be obtained immediately for each new input source.

location: The location of the input sources in a file or bundle.

Returns a result code. The function returns paramErr (-50) if location is invalid or the input sources in the specified location cannot be registered. Otherwise, it returns noErr (0).

This function enables an installer for an input method bundle or a keyboard layout file or bundle to notify the system to register these new input sources. The system can then locate the specified file or bundle and perform any necessary cache rebuilds so that the installer can immediately call TISCreateInputSourceList with appropriate properties (for example, a bundle ID or input source ID) to get text input source references for one or more of the newly registered input sources.

You can only use this function to register the following:

Keyboard layout files or bundles in the /Library/Keyboard Layouts/ or ~/Library/Keyboard Layouts/ directory (available to all users or to the current user, respectively). Such keyboard layouts, once enabled, are selectable.
Input method bundles in the new Library/Input Methods/ or ~/Library/Input Methods/ directories (available to all users or to the current user, respectively).
Note: Input method bundles can include private non-selectable keyboard layouts for use with SetInputMethodKeyboardLayoutOverride. These are registered automatically when the input method is registered, and do not need to be separately registered. They are not registered using TISRegisterInputSource.
Security: Any code that calls RegisterInputSource is part of an application or service that has already been validated in some way (for instance, by the user).

See also:

TextInputSourceMBS.RegisterInputSource(URL as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Mac MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Registers any new input sources in a file or bundle so a text input source reference can be obtained immediately for each new input source.

location: The location of the input sources in a file or bundle.

Returns a result code. The function returns paramErr (-50) if location is invalid or the input sources in the specified location cannot be registered. Otherwise, it returns noErr (0).

This function enables an installer for an input method bundle or a keyboard layout file or bundle to notify the system to register these new input sources. The system can then locate the specified file or bundle and perform any necessary cache rebuilds so that the installer can immediately call TISCreateInputSourceList with appropriate properties (for example, a bundle ID or input source ID) to get text input source references for one or more of the newly registered input sources.

You can only use this function to register the following:

Keyboard layout files or bundles in the /Library/Keyboard Layouts/ or ~/Library/Keyboard Layouts/ directory (available to all users or to the current user, respectively). Such keyboard layouts, once enabled, are selectable.
Input method bundles in the new Library/Input Methods/ or ~/Library/Input Methods/ directories (available to all users or to the current user, respectively).
Note: Input method bundles can include private non-selectable keyboard layouts for use with SetInputMethodKeyboardLayoutOverride. These are registered automatically when the input method is registered, and do not need to be separately registered. They are not registered using TISRegisterInputSource.
Security: Any code that calls RegisterInputSource is part of an application or service that has already been validated in some way (for instance, by the user).

See also:

Previous items

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


💬 Ask a question or report a problem
The biggest plugin in space...