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

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

Разработчик

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

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

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

NSUserInterfaceItemSearching

NSUserInterfaceItemSearching протокол показывает, что приложение может реализовать Центр внимания для Справки для их собственных данных справки.

В целом пользователи считают функциональность поиска Справки очень полезной. Однако много крупных приложений не используют Справку Apple API из-за кросс-платформенных требований. Следовательно, важные темы Справки не представлены как часть Меню справки. Этот API позволяет разработчикам включать свои собственные темы Справки и в полной мере пользоваться функцией Help.

В Вашем приложении Вы реализуете NSUserInterfaceItemSearching протокол и затем регистрирует Ваш объект в registerUserInterfaceItemSearchHandler:.

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

Не применимый

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

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

Swift

import AppKit

Objective C

@import AppKit;

Доступность

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

Покажите меню справки
  • localizedTitlesForItem (_:) - localizedTitlesForItem: Требуемый

    Возвращает массив локализованных строк, которые сформируют элемент меню справки. (требуемый)

    Объявление

    Swift

    func localizedTitlesForItem(_ item: AnyObject) -> [AnyObject]

    Objective C

    - (NSArray *)localizedTitlesForItem:(id)item

    Параметры

    item

    В элементе в меню справки.

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

    NSArray из NSStrings (локализованный для дисплея в меню), который будет объединен с разделителями для формирования заголовка пункта меню.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

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

  • showAllHelpTopicsForSearchString (_:) - showAllHelpTopicsForSearchString:

    Если этот метод реализован, «Показывают, что Весь элемент» Тем Справки появится в меню, и этот метод вызывают, когда пользователь выбирает его.

    Объявление

    Swift

    optional func showAllHelpTopicsForSearchString(_ searchString: String)

    Objective C

    - (void)showAllHelpTopicsForSearchString:(NSString *)searchString

    Параметры

    searchString

    Строка поиска.

    Обсуждение

    Приложение должно показать все свои результаты для этого поиска, не включающего результаты для пунктов меню. Строка для «Показывает, что Все Темы Справки» являются системой, определенной и локализованной, и не могут быть изменены пользователем.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

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

Содержание помощи
  • searchForItemsWithSearchString (_: resultLimit:matchedItemHandler:) - searchForItemsWithSearchString:resultLimit:matchedItemHandler: Требуемый

    Ищите указанные элементы с пределом результата. (требуемый)

    Объявление

    Swift

    func searchForItemsWithSearchString(_ searchString: String, resultLimit resultLimit: Int, matchedItemHandler handleMatchedItems: ([AnyObject]!) -> Void)

    Objective C

    - (void)searchForItemsWithSearchString:(NSString *)searchString resultLimit:(NSInteger)resultLimit matchedItemHandler:(void (^)(NSArray *items))handleMatchedItems

    Параметры

    searchString

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

    resultLimit

    Максимальное количество результатов, которые обработает Центр внимания для Справки. Любые результаты, возвращенные вне этого предела, будут проигнорированы, но для производительности обосновывает, что лучше не превысить его.

    handleMatchedItems

    Блок раньше добавлял результаты к поиску.

    Блок берет один параметр:

    items

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

    Обсуждение

    Поиск элементов, соответствующих предоставленную строку поиска и, возвращает их путем вызова соответствующего блока элементов, передачи массива элементов для добавления к меню справки. Платформа не заботится, каковы эти элементы. Они просто используются для идентификации определенных результатов поиска для других методов в этом протоколе. Не предполагайте, что это вызовут от основного потока UI.

    Когда searchForItemsWithSearchString:resultLimit:matchedItemHandler: вызывается снова, клиент должен отменить любые предыдущие происходящие поиски лучшей производительности. Если не Центр внимания для Справки проигнорирует более старые результаты.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

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

  • performActionForItem (_:) - performActionForItem:

    Вызванный, когда пользователь выбирает результат поиска в Меню справки.

    Объявление

    Swift

    optional func performActionForItem(_ item: AnyObject)

    Objective C

    - (void)performActionForItem:(id)item

    Параметры

    item

    Элемент в меню справки.

    Обсуждение

    Реализация по умолчанию переводит Средство просмотра Справки в рабочее состояние для элемента Справки.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

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