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

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

Разработчик

Ссылка платформы InputMethodKit ссылка класса IMKCandidates

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

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

IMKCandidates

IMKCandidates класс представляет кандидатов пользователям и уведомляет надлежащее IMKInputController возразите, когда пользователь выберет кандидата. Кандидаты являются альтернативными символами для данной входной последовательности. IMKCandidates поддержки класса с помощью окна кандидатов в методе ввода; использование IMKCandidates является дополнительным. Не все методы ввода требуют их.

Когда Вы создаете IMKCandidates объект, Вы присоединяете его к IMKServer возразите для своего метода ввода. Тогда необходимо переопределить IMKInputController методы candidateSelectionChanged: и candidateSelected: а также реализуйте метод кандидатов в своем объекте делегата. IMKInputController разделите на подклассы предоставляет кандидатов к IMKCandidates объект путем реализации метода кандидатов. Когда Вы будете готовы вывести на экран окно кандидатов, вызовите метод кандидатов, чтобы обновить кандидатов и показать окно кандидатов.

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

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

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

Swift

import InputMethodKit

Objective C

@import InputMethodKit;

Доступность

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

Инициализация окна кандидатов
  • init (server:panelType:) - initWithServer:panelType:

    Возвращает инициализированный IMKCandidates объект.

    Объявление

    Swift

    init!(server server: IMKServer!, panelType panelType: IMKCandidatePanelType)

    Objective C

    - (id)initWithServer:(IMKServer *)server panelType:(IMKCandidatePanelType)panelType

    Параметры

    server

    IMKServer объект, управляющий кандидатом и типом панели.

    panelType

    Тип панели для окна кандидата.

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

    Инициализированный IMKCandidates объект.

    Обсуждение

    Когда метод ввода выделяет IMKCandidates объект это должно инициализировать тот объект путем вызова этого метода.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

Управление ключами выбора
  • setSelectionKeys: - setSelectionKeys:

    Устанавливает ключи выбора для кандидатов.

    Объявление

    Objective C

    - (void)setSelectionKeys:(NSArray *)keyCodes

    Параметры

    keyCodes

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

    Обсуждение

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

    Число ключей выбора определяет, сколько кандидатов выведено на экран на страницу. Например, если Вы передаете массив четырех кодов клавиши, четыре кандидата выведены на экран на страницу. Если Вы передаете одиннадцать кодов клавиши, одиннадцать кандидатов выведены на экран. По умолчанию коды клавиши отображаются с помощью раскладки клавиатуры, исходный ID которой com.apple.keylayout.US. Можно заменить расположение по умолчанию путем вызова setSelectionKeysKeylayout:. Ключи выбора по умолчанию являются цифрами 1 - 9 или, с точки зрения кодов клавиши, 18, 19, 20, 21, 23, 22, 26, 28, и 25.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – selectionKeys

  • selectionKeys - selectionKeys

    Возвращает массив NSNumber объекты, где каждый NSNumber объект представляет код виртуальной клавиши.

    Объявление

    Objective C

    - (NSArray *)selectionKeys

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

    Массив NSNumber объекты.

    Обсуждение

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

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – setSelectionKeys:

  • setSelectionKeysKeylayout: - setSelectionKeysKeylayout:

    Устанавливает ключевое расположение, использующееся для отображения кодов виртуальной клавиши на символы.

    Объявление

    Objective C

    - (void)setSelectionKeysKeylayout:(TISInputSourceRef)layout

    Параметры

    layout

    Ключевое расположение для использования.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – selectionKeysKeylayout

  • selectionKeysKeylayout - selectionKeysKeylayout

    Возвращает ключевое расположение, отображающее коды виртуальной клавиши на ключи выбора.

    Объявление

    Objective C

    - (TISInputSourceRef)selectionKeysKeylayout

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

    Ключевое расположение в использовании. По умолчанию это - ключевое расположение, исходный ID которого com.apple.keylayout.US.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – setSelectionKeysKeylayout:

Управление видимостью окна и поведением
  • покажите (_:) - покажите:

    Показывает окно кандидатов.

    Объявление

    Swift

    func show(_ locationHint: IMKCandidatesLocationHint)

    Objective C

    - (void)show:(IMKCandidatesLocationHint)locationHint

    Параметры

    locationHint

    IMKCandidatesLocationHint, постоянный, который указывает желаемую позицию окна кандидатов. Набор Метода ввода использует подсказку для размещения окна кандидатов в расположение, которое является около расположения подсказки и гарантирует, что окно кандидатов полностью видимо.

    Обсуждение

    Ваш метод ввода вызывает этот метод, когда является надлежащим во время текстового преобразования вывести на экран список кандидатов.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

    См. также

    – скрыться
    – isVisible

  • скройтесь () - скрыться

    Скрывает окно кандидатов, если это видимо.

    Объявление

    Swift

    func hide()

    Objective C

    - (void)hide

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

    См. также

    – покажите:
    – isVisible

  • isVisible () - isVisible

    Возвраты, видимо ли окно кандидатов.

    Объявление

    Swift

    func isVisible() -> Bool

    Objective C

    - (BOOL)isVisible

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

    YEStrue если окно кандидатов видимо; иначе NOfalse.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

    См. также

    – скрыться
    – покажите:

  • setDismissesAutomatically: - setDismissesAutomatically:

    Устанавливает состояние флага, определяющего, отклоняет ли окно кандидатов автоматически.

    Объявление

    Objective C

    - (void)setDismissesAutomatically:(BOOL)flag

    Параметры

    flag

    YEStrue для имения окна кандидатов отклоняют автоматически; иначе NOfalse.

    Обсуждение

    По умолчанию, если пользователь нажимает Return или клавиши Enter, кандидаты уволены и a candidateSelected: сообщение отправляется во входной контроллер. Можно вызвать setDismissesAutomatically: метод, передавая NOfalse как flag параметр для изменения поведения увольнения по умолчанию. Входной контроллер все еще получает a candidatesSelected: сообщение.

    Когда Вы устанавливаете флаг в NOfalse, метод ввода обрабатывает ввод текста, динамично обновляя содержание кандидатов как текст вводов данных пользователем. Когда сеанс деактивируется, окно кандидата скрыто независимо от состояния флага.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – dismissesAutomatically

  • dismissesAutomatically - dismissesAutomatically

    Возвращает состояние флага, определяющего, отклоняет ли окно кандидатов автоматически.

    Объявление

    Objective C

    - (BOOL)dismissesAutomatically

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

    YEStrue если окно кандидатов отклоняет автоматически; иначе NOfalse.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – setDismissesAutomatically:

  • updateCandidates () - updateCandidates

    Обновляет кандидатов, выведенных на экран в окне кандидатов.

    Объявление

    Swift

    func updateCandidates()

    Objective C

    - (void)updateCandidates

    Обсуждение

    При вызове этого метода Набор Метода ввода вызывает метод кандидатов IMKInputController класс. Обратите внимание на то, что кандидаты перечисляют, обновляется, но не изменяется видимое состояние окна. Другими словами, если окно скрыто, это остается скрытым. Если окно видимо, это остается видимым.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

Управление типом окна и текстовыми атрибутами
  • panelType () - panelType

    Возвращает стиль окна кандидатов.

    Объявление

    Swift

    func panelType() -> IMKCandidatePanelType

    Objective C

    - (IMKCandidatePanelType)panelType

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

    IMKCandidatePanelType, постоянный, который представляет стиль окна кандидатов.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

    См. также

    – setPanelType:

  • setPanelType (_:) - setPanelType:

    Устанавливает стиль окна кандидатов.

    Объявление

    Swift

    func setPanelType(_ panelType: IMKCandidatePanelType)

    Objective C

    - (void)setPanelType:(IMKCandidatePanelType)panelType

    Параметры

    panelType

    IMKCandidatePanelType, постоянный, который представляет стиль окна кандидатов.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

    См. также

    – panelType

  • setAttributes: - setAttributes:

    Устанавливает атрибуты стиля для окна кандидатов.

    Объявление

    Objective C

    - (void)setAttributes:(NSDictionary *)attributes

    Параметры

    attributes

    Словарь, содержащий ключи и оценивающий за стили для использования. Можно предоставить ключи и значения, перечисленные в следующей таблице:

    Ключ

    Значение

    NSFontAttributeName

    NSFont объект. Установка атрибута шрифта устанавливает шрифт, использующийся для привлечения Кандидатов. Это не производит ключи выбора, всегда рисующиеся в том же шрифте. Обратите внимание на то, что для установки размера шрифта необходимо использовать эту пару ключ/значение.

    IMKCandidatesOpacityAttributeName

    NSNumber объект, представляющий значение с плавающей точкой между 0.0 (прозрачный) и 1.0 (абсолютно непрозрачный. Непрозрачность по умолчанию 1.0.

    NSForegroundColorAttributeName

    NSColor возразите для использования для цвета текста-кандидата. Цвет по умолчанию является черным.

    NSBackgroundColorDocumentAttribute

    NSColor возразите для использования для цвета фона позади текста-кандидата.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – атрибуты

  • атрибуты - атрибуты

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

    Объявление

    Objective C

    - (NSDictionary *)attributes

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

    Словарь, содержащий ключи и оценивающий за стили.

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

    Objective C

    @import InputMethodKit;

    Доступность

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

    См. также

    – setAttributes:

Показ окна аннотации
  • showAnnotation (_:) - showAnnotation:

    Выводит на экран строку аннотации в окне аннотации.

    Объявление

    Swift

    func showAnnotation(_ annotationString: NSAttributedString!)

    Objective C

    - (void)showAnnotation:(NSAttributedString *)annotationString

    Параметры

    annotationString

    Строка для отображения.

    Обсуждение

    Строка аннотации объясняет или комментирует строку кандидата в окне кандидатов. Окно аннотации является маленьким, безграничным окном, которое является выровненное текущего окна кандидатов. Метод ввода вызывает showAnnotation: когда candidateSelectionChanged: метод IMKInputController класс вызывают, и строка кандидата имеет аннотации.

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

Константы
  • IMKCandidatePanelType

    Типы окон кандидатов обеспечивают Набором Метода ввода.

    Объявление

    Swift

    typealias IMKCandidatePanelType = Int

    Objective C

    enum { kIMKSingleColumnScrollingCandidatePanel = 1, kIMKScrollingGridCandidatePanel = 2, kIMKSingleRowSteppingCandidatePanel = 3 }; typedef NSUInteger IMKCandidatePanelType;

    Константы

    • kIMKSingleColumnScrollingCandidatePanel

      kIMKSingleColumnScrollingCandidatePanel

      Окно, которое выводит на экран один столбец и может прокрутить при необходимости.

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

    • kIMKScrollingGridCandidatePanel

      kIMKScrollingGridCandidatePanel

      Окно, которое выводит на экран сетку и может прокрутить при необходимости.

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

    • kIMKSingleRowSteppingCandidatePanel

      kIMKSingleRowSteppingCandidatePanel

      Окно, выводящее на экран единственную строку.

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

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

  • IMKCandidatesLocationHint

    Подсказки, предлагающие, куда поместить окно кандидатов.

    Объявление

    Swift

    typealias IMKCandidatesLocationHint = Int

    Objective C

    enum { kIMKLocateCandidatesAboveHint = 1, kIMKLocateCandidatesBelowHint = 2, kIMKLocateCandidatesLeftHint = 3, kIMKLocateCandidatesRightHint = 4 };typedef NSUInteger IMKCandidatesLocationHint;

    Константы

    • kIMKLocateCandidatesAboveHint

      kIMKLocateCandidatesAboveHint

      Поместите окно кандидатов выше запуска выбора текущего текста.

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

    • kIMKLocateCandidatesBelowHint

      kIMKLocateCandidatesBelowHint

      Поместите окно кандидатов ниже запуска выбора текущего текста.

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

    • kIMKLocateCandidatesLeftHint

      kIMKLocateCandidatesLeftHint

      Поместите окно кандидатов налево от выбора текущего текста.

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

    • kIMKLocateCandidatesRightHint

      kIMKLocateCandidatesRightHint

      Поместите окно кандидатов направо от выбора текущего текста.

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

    Обсуждение

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

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

    Objective C

    @import InputMethodKit;

    Swift

    import InputMethodKit

    Доступность

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

  • IMKCandidatesOpacityAttributeName

    Уровень непрозрачности для окна кандидатов.

    Объявление

    Swift

    var IMKCandidatesOpacityAttributeName: NSString!

    Objective C

    extern const *NSString IMKCandidatesOpacityAttributeName;

    Константы

    • IMKCandidatesOpacityAttributeName

      IMKCandidatesOpacityAttributeName

      Атрибут непрозрачности для окна кандидатов. Присваиваемое значение должно быть NSNumber объект, представляющий значение от 0 до 1.

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