Platforms to show: All Mac Windows Linux Cross-Platform
Back to NSHelpManagerMBS class.
NSHelpManagerMBS.isContextHelpModeActive as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa | MBS MacBase Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true when the application is in context-sensitive help mode, false otherwise.
In context-sensitive help mode, when a user clicks a user interface item, help for that item is displayed in a small window just below the cursor.
NSHelpManagerMBS.NSContextHelpModeDidActivateNotification as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa | MBS MacBase Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Posted when the application enters context-sensitive help mode. This typically happens when the user holds down the Help key.
The notification object is the help manager. This notification does not contain a userInfo dictionary.
NSHelpManagerMBS.NSContextHelpModeDidDeactivateNotification as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa | MBS MacBase Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Posted when the application exits context-sensitive help mode. This happens when the user clicks the mouse button while the cursor is anywhere on the screen after displaying a context-sensitive help topic.
The notification object is the help manager. This notification does not contain a userInfo dictionary.
NSHelpManagerMBS.setContextHelpModeActive(active as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa | MBS MacBase Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
active: True turns on context-sensitive help, false turns it off.
You never send this message directly; instead, the NSApplication method activateContextHelpMode activates context-sensitive help mode, and the first mouse click after displaying the context-sensitive help window deactivates it.
When the application enters context-sensitive help mode, the help manager posts an NSContextHelpModeDidActivateNotification to the default notification center. When the application returns to normal operation, the help manager posts an NSContextHelpModeDidDeactivateNotification.
The items on this page are in the following plugins: MBS MacBase Plugin.