NSUserInterfaceItemSearchDataSource

Центр внимания Для Справки обеспечивает механизм, чтобы индексировать и искать графические интерфейсы пользователя, состоящие из иерархий объектов включая, но не ограничиваясь этим, Меню, Windows, Представления, Средства управления и Атрибуты Доступности.

Чтобы позволить Центру внимания Для Справки найти элементы UI не в меню, Центр внимания Для Справки обеспечивает дополнительный механизм в форме протокола, позволяющего разработчикам определять местоположение этих дополнительных элементов UI и обеспечивать их для Развертки бегущим лучом Для Справки.

Следующая функция Набора Приложения добавляет поисковый источник данных для Развертки бегущим лучом Для Справки:

      extern void NSRegisterSearchDataSource(id<NSUserInterfaceItemSearchDataSource> dataSource);

Следующая функция Набора Приложения удаляет поисковый источник данных из Центра внимания Для Справки:

      extern void NSUnregisterSearchDataSource(id<NSUserInterfaceItemSearchDataSource> dataSource);

Для описаний этих и других функций Набора Приложения, которые можно использовать с Центром внимания Для Справки, посмотрите Ссылку Функций AppKit.

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

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

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

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

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

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

Добавление элементов к центру внимания для меню справки


    
    itemsForSearchString:withPartialResults:
    - itemsForSearchString:withPartialResults:

Требуемый

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

Объявление

Objective C

- (NSArray*)itemsForSearchString:(NSString*)searchString withPartialResults:(BOOL*)partialResults;

Параметры


      searchString

Строка поиска, которую пользователь ввел в поле Искомого текста.


      partialResults

На выводе, установленном этот параметр на YEStrue если результаты возвратились, являются только частичными , и Центр внимания для Справки должен вызвать этот метод снова для большего количества результатов. В этом случае это - Ваша ответственность помнить предыдущую строку поиска, возвратить дополнительные результаты, если строка поиска совпадает с в прошлый раз, или инициируйте новый поиск, если изменилась строка.

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

Массив идентификаторов для элементов интерфейса пользователя, касающихся строки поиска.

Обсуждение

Идентификаторы не интерпретируются Центром внимания Для Справки; они используются только для идентификации определенных результатов поиска для другого Центра внимания Для методов Справки. Вы ответственны за поддержание отображения этих идентификаторов к элементам результата поиска.

Этот метод можно вызвать от потока кроме основного потока UI.


    
    titlesForItem:
    - titlesForItem:

Требуемый

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

Объявление

Objective C

- (NSArray*)titlesForItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

Обсуждение

Заголовок пункта меню должен указать всю иерархию возвращаемого элемента UI; например, Preferences > Plain Text Font. Угловая скобка seperators предоставлена Центром внимания Для Справки — необходимо обеспечить массив строк для элементов в иерархии; например, [NSArray, arrayWithObjects:“Preferences”,“Plain Text Font”,nil].

См. также

– itemsForSearchString:withPartialResults:


    
    iconForItem:
    - iconForItem:

Возвращает пользовательский значок для отображения в меню для этого элемента.

Объявление

Objective C

- (NSImage*)iconForItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

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

Пользовательский значок для отображения, когда этот элемент возвращается в Меню справки.

Обсуждение

Реализация этого метода является дополнительной.

См. также

– itemsForSearchString:withPartialResults:

Показ элементов UI


    
    showItem:
    - showItem:

Требуемый

Вызванный, когда Центр внимания Для Справки должен показать элемент UI, связанный с этим результатом поиска. (требуемый)

Объявление

Objective C

- (void)showItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

Обсуждение

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

См. также

– itemsForSearchString:withPartialResults:
– screenRectForItem:


    
    screenRectForItem:
    - screenRectForItem:

Требуемый

Возвращает границы (требуемого) элемента UI

Объявление

Objective C

- (NSRect)screenRectForItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

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

Прямоугольник (NSRect) в координатах экрана границы элемента UI.

Обсуждение

Центр внимания Для Справки использует прямоугольник, который Вы возвращаете для определения, где определить местоположение плавающего указателя, выделяющего элемент UI для пользователя. Этот метод вызывают только после showItem: метод вызвали.

См. также

– itemsForSearchString:withPartialResults:
– showItem:


    
    itemIsVisible:
    - itemIsVisible:

Вызванный по мере необходимости, чтобы проверить, что элемент видим на экране.

Объявление

Objective C

- (void)itemIsVisible:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

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

YEStrue если элемент все еще видим.

Обсуждение

Центр внимания Для Справки вызывает этот метод, чтобы проверить, что это должно продолжать показывать указатель. Реализация этого метода является дополнительной.

См. также

– itemsForSearchString:withPartialResults:
– showItem:


    
    hideContainerForItem
    - hideContainerForItem

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

Объявление

Objective C

- (void)hideContainerForItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

Обсуждение

Реализация этого метода является дополнительной.

См. также

– itemsForSearchString:withPartialResults:
– showItem:


    
    hideItem:
    - hideItem:

Вызванный, когда Центр внимания Для Справки хочет скрыть ранее показанный элемент.

Объявление

Objective C

- (void)hideItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

Обсуждение

Реализация этого метода является дополнительной.

См. также

– itemsForSearchString:withPartialResults:
– showItem:
– itemIsVisible:

Вызов элемента UI


    
    performActionForItem:
    - performActionForItem:

Вызванный, когда Центр внимания Для Справки хочет выполнить действие, связанное с этим элементом UI.

Объявление

Objective C

- (void)performActionForItem:(id)item;

Параметры


      item

Элемент UI показан Центром внимания Для Справки в ответ на строку поиска.

Обсуждение

Когда пользователь выбирает элемент в Центре внимания Для Меню справки и щелкает мышью или нажимает Enter или Return, можно выполнить работу, обычно вызванную пользователем, нажимающим на элемент в UI. Реализация этого метода является дополнительной.

См. также

– itemsForSearchString:withPartialResults: