Class

NSHelpManager

An object for displaying online help for an app.

Declaration

@interface NSHelpManager : NSObject

Overview

The NSHelpManager class provides an approach to displaying online help. An app contains one NSHelpManager object.

Topics

Getting the Help Manager

sharedHelpManager

Returns the shared NSHelpManager instance, creating it if it does not already exist.

Displaying Help

- findString:inBook:

Performs a search for the specified string in the specified book.

- openHelpAnchor:inBook:

Finds and displays the text at the given anchor location in the given book.

Dynamically Adding Help Books

- registerBooksInBundle:

Registers one or more help books in the given bundle.

Configuring Context-Sensitive Help

- setContextHelp:forObject:

Associates help content with an object.

- removeContextHelpForObject:

Removes the association between an object and its context-sensitive help.

Displaying Context-Sensitive Help

- contextHelpForObject:

Returns context-sensitive help for an object.

- showContextHelpForObject:locationHint:

Displays the context-sensitive help for a given object at or near the point on the screen specified by a given point.

Notifications

NSContextHelpModeDidActivateNotification

Posted when the application enters context-sensitive help mode. This typically happens when the user holds down the Help key.

NSContextHelpModeDidDeactivateNotification

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.

Relationships

Inherits From

See Also

App Help

NSUserInterfaceItemSearching

A set of methods an app can implement to provide Spotlight for Help for its own custom help data.