Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы AppKit ссылка класса NSHelpManager

Опции
Развертывание Target:

На этой странице
Язык:

NSHelpManager

NSHelpManager класс обеспечивает подход к отображению онлайн-справки. Приложение содержит тот NSHelpManager объект.

Наследование

Соответствует

Оператор импорта

Swift

import AppKit

Objective C

@import AppKit;

Доступность

Доступный в OS X v10.0 и позже.

Получение менеджера по справке
  • sharedHelpManager () + sharedHelpManager

    Возвращает совместно используемое NSHelpManager экземпляр, создавая его, если это уже не существует.

    Объявление

    Swift

    class func sharedHelpManager() -> NSHelpManager

    Objective C

    + (NSHelpManager *)sharedHelpManager

    Возвращаемое значение

    Совместно используемый менеджер по справке.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

Отображение справки
  • findString (_: inBook:) - findString:inBook:

    Выполняет поиск указанной строки в указанной книге.

    Объявление

    Swift

    func findString(_ query: String, inBook book: String?)

    Objective C

    - (void)findString:(NSString *)query inBook:(NSString *)book

    Параметры

    query

    Строка для поиска.

    book

    Локализованная книга справки для поиска. Когда nil, ищутся все установленные книги справки.

    Обсуждение

    Для поиска строки в локализованной книге справки пакета Вы могли использовать код, подобный следующему:

    • NSString *locBookName = [[NSBundle mainBundle] objectForInfoDictionaryKey: @"CFBundleHelpBookName"];
    • [[NSHelpManager sharedHelpManager] findString:@"Hello" inBook:locBookName];

    Это - обертка для AHRegisterHelpBook (который вызывают только один раз для регистрации книги справки, указанной в основном пакете приложения), и AHSearch.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.3 и позже.

  • openHelpAnchor (_: inBook:) - openHelpAnchor:inBook:

    Находит и выводит на экран текст в данном расположении привязки в данной книге.

    Объявление

    Swift

    func openHelpAnchor(_ anchor: String, inBook book: String?)

    Objective C

    - (void)openHelpAnchor:(NSString *)anchor inBook:(NSString *)book

    Параметры

    anchor

    Расположение требуемого текста.

    book

    Книга справки, содержащая привязку. Когда nil, ищутся все установленные книги справки.

    Обсуждение

    Для открытия привязки в локализованной книге справки пакета Вы могли использовать код, подобный следующему:

    • NSString *locBookName = [[NSBundle mainBundle] objectForInfoDictionaryKey: @"CFBundleHelpBookName"];
    • [[NSHelpManager sharedHelpManager] openHelpAnchor:@"anchor1" inBook:locBookName];

    Этот метод является оберткой для AHRegisterHelpBook (который вызывают только один раз для регистрации книги справки, указанной в основном пакете приложения), и AHLookupAnchor.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.3 и позже.

Динамично добавляющие книги справки
  • registerBooksInBundle (_:) - registerBooksInBundle:

    Регистры одна или более книг справки в данном пакете.

    Объявление

    Swift

    func registerBooksInBundle(_ bundle: NSBundle) -> Bool

    Objective C

    - (BOOL)registerBooksInBundle:(NSBundle *)bundle

    Параметры

    bundle

    Пакет для дополнительных книг справки. Книги в основном пакете автоматически регистрируются.

    Возвращаемое значение

    YEStrue если регистрация успешна, NOfalse если, если пакет не содержит книг справки или если регистрация перестала работать.

    Обсуждение

    Вы используете registerBooksInBundle: зарегистрировать справку регистрирует, например, сменный пакет. Info.plist в пакете должен содержать путь к каталогу книги справки, указывающий одну или более папок, содержащих книги справки.

    Основной пакет автоматически регистрируется openHelpAnchor:inBook: и findString:inBook: .

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.6 и позже.

Конфигурирование контекстно-зависимой справки
  • isContextHelpModeActive () + isContextHelpModeActive

    Указывает, активен ли контекстно-зависимый режим справки.

    Объявление

    Swift

    class func isContextHelpModeActive() -> Bool

    Objective C

    + (BOOL)isContextHelpModeActive

    Возвращаемое значение

    YEStrue когда приложение находится в контекстно-зависимом режиме справки, NOfalse иначе.

    Обсуждение

    В контекстно-зависимом режиме справки, когда пользователь щелкает по элементу интерфейса пользователя, справка для того элемента выведена на экран в маленьком окне чуть ниже курсора.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    + setContextHelpModeActive:

  • setContextHelpModeActive (_:) + setContextHelpModeActive:

    Указывает, активен ли контекстно-зависимый режим справки.

    Объявление

    Swift

    class func setContextHelpModeActive(_ contextHelpActive: Bool)

    Objective C

    + (void)setContextHelpModeActive:(BOOL)contextHelpActive

    Параметры

    contextHelpActive

    YEStrue включает контекстно-зависимую справку, NOfalse выключает его.

    Обсуждение

    Вы никогда не отправляете это сообщение непосредственно; вместо этого, NSApplication метод activateContextHelpMode: активирует контекстно-зависимый режим справки, и первый щелчок мышью после отображения контекстно-зависимого окна справки деактивировал его.

    Когда приложение вводит контекстно-зависимый режим справки, менеджер по справке отправляет NSContextHelpModeDidActivateNotification к центру уведомления по умолчанию. Когда приложение возвращается к нормальному функционированию, менеджер по справке отправляет NSContextHelpModeDidDeactivateNotification.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    + isContextHelpModeActive

  • setContextHelp (_: forObject:) - setContextHelp:forObject:

    Партнеры помогают содержанию с объектом.

    Объявление

    Swift

    func setContextHelp(_ help: NSAttributedString, forObject object: AnyObject)

    Objective C

    - (void)setContextHelp:(NSAttributedString *)help forObject:(id)object

    Параметры

    help

    Содержание справки для соединения с object.

    object

    Объект связаться с help.

    Обсуждение

    Когда приложение вводит контекстно-зависимый режим справки, если object щелкается, help появляется в контекстно-зависимом окне справки.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – removeContextHelpForObject:

  • removeContextHelpForObject (_:) - removeContextHelpForObject:

    Удаляет ассоциацию между объектом и его контекстно-зависимой справкой.

    Объявление

    Swift

    func removeContextHelpForObject(_ object: AnyObject)

    Objective C

    - (void)removeContextHelpForObject:(id)object

    Параметры

    object

    Объект разъединить с его содержанием справки.

    Обсуждение

    Если object не имеет контекстно-зависимой справки связанной с ним, этот метод ничего не делает.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – setContextHelp:forObject:

Отображение контекстно-зависимой справки
  • contextHelpForObject (_:) - contextHelpForObject:

    Возвращает контекстно-зависимую справку для объекта.

    Объявление

    Swift

    func contextHelpForObject(_ object: AnyObject) -> NSAttributedString?

    Objective C

    - (NSAttributedString *)contextHelpForObject:(id)object

    Параметры

    object

    Объект, который разыскивается контекстно-зависимая справка.

    Возвращаемое значение

    Контекстно-зависимое содержание справки.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – setContextHelp:forObject:
    – showContextHelpForObject:locationHint:

  • showContextHelpForObject (_: locationHint:) - showContextHelpForObject:locationHint:

    Выводит на экран контекстно-зависимую справку для данного объекта в или около точки на экране, указанном данной точкой.

    Объявление

    Swift

    func showContextHelpForObject(_ object: AnyObject, locationHint point: NSPoint) -> Bool

    Objective C

    - (BOOL)showContextHelpForObject:(id)object locationHint:(NSPoint)point

    Параметры

    object

    Объект, который разыскивается контекстно-зависимая справка.

    point

    Расположение на экране, в котором можно вывести на экран содержание справки; это обычно находится под курсором.

    Возвращаемое значение

    YEStrue когда содержание справки успешно выведено на экран. NOfalse если содержание справки не выведено на экран (например, когда нет никакой контекстно-зависимой справки, связанной с object).

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – contextHelpForObject:

Уведомления
  • NSContextHelpModeDidActivateNotification NSContextHelpModeDidActivateNotification

    Отправленный, когда приложение вводит контекстно-зависимый режим справки. Когда пользователь удерживает Клавишу вызова справки, это обычно происходит.

    Объект уведомления является менеджером по справке. Это уведомление не содержит a userInfo словарь.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

  • NSContextHelpModeDidDeactivateNotification NSContextHelpModeDidDeactivateNotification

    Отправленный, когда приложение выходит из контекстно-зависимого режима справки. Это происходит, когда пользователь щелкает кнопкой мыши, в то время как курсор находится где угодно на экране после отображения контекстно-зависимой темы справки.

    Объект уведомления является менеджером по справке. Это уведомление не содержит a userInfo словарь.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.