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

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

Разработчик

Ссылка платформы NotificationCenter ссылка на протокол NCWidgetProviding

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

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

NCWidgetProviding

NCWidgetProviding протокол позволяет Вам настроить часть появления, и поведение виджета (виджет является расширением в представлении Today).

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

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

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

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

Swift

import NotificationCenter

Objective C

@import NotificationCenter;

Доступность

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

Настройка граничных вставок
  • widgetMarginInsetsForProposedMarginInsets (_:) - widgetMarginInsetsForProposedMarginInsets:

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

    Объявление

    Swift

    optional func widgetMarginInsetsForProposedMarginInsets(_ defaultMarginInsets: NSEdgeInsets) -> NSEdgeInsets

    Objective C

    - (NSEdgeInsets)widgetMarginInsetsForProposedMarginInsets:(NSEdgeInsets)defaultMarginInsets

    Параметры

    defaultMarginInsets

    Граничные вставки по умолчанию, которые доступны виджету.

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

    Значение типа UIEdgeInsets это содержит пользовательские вставки поля, которые виджет использует вместо значений по умолчанию.

    Обсуждение

    Виджет может реализовать этот метод для возврата пользовательских граничных значений вставки для использования вместо значений по умолчанию, указанных в defaultMarginInsets. (Если виджет не должен использовать пользовательские значения, он должен возвратить неизменные значения по умолчанию в своей реализации.), Если виджет не реализует этот метод, он автоматически получает граничные значения вставки по умолчанию.

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

    Objective C

    @import NotificationCenter;

    Swift

    import NotificationCenter

    Доступность

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

Обновление содержания виджета
  • widgetPerformUpdateWithCompletionHandler (_:) - widgetPerformUpdateWithCompletionHandler:

    Вызванный, чтобы дать виджету возможность обновить ее содержание.

    Объявление

    Swift

    optional func widgetPerformUpdateWithCompletionHandler(_ completionHandler: ((NCUpdateResult) -> Void)!)

    Objective C

    - (void)widgetPerformUpdateWithCompletionHandler:(void (^)(NCUpdateResult result))completionHandler

    Параметры

    completionHandler

    Блок, который вызовут, когда было обновлено содержание виджета.

    Блок берет следующий параметр:

    result

    Значение типа NCUpdateResult это описывает результат процедуры обновления. (Коды Результата обновления перечисляют возможные значения result.)

    Обсуждение

    Этот метод вызывают, чтобы дать виджету возможность обновить ее содержание и перерисовать ее представление до работы, такой как снимок. Когда виджет закончен, обновив его содержание (и перерисовка, если необходимый), виджет должен вызвать блок обработчика завершения, передав надлежащее NCUpdateResult значение.

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

    Objective C

    @import NotificationCenter;

    Swift

    import NotificationCenter

    Доступность

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

Поддержка редактирования
  • widgetAllowsEditing widgetAllowsEditing Свойство

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

    Объявление

    Swift

    optional var widgetAllowsEditing: Bool { get }

    Objective C

    @property(readonly) BOOL widgetAllowsEditing

    Обсуждение

    Когда виджет это свойство в, поддерживающий редактирование устанавливает YEStrue, это автоматически получает предоставленную системой кнопку в своей области заголовка, что пользователи принимают решение начать или закончить редактирование. Значение по умолчанию этого свойства NOfalse.

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

    Objective C

    @import NotificationCenter;

    Swift

    import NotificationCenter

    Доступность

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

  • widgetDidBeginEditing () - widgetDidBeginEditing

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

    Объявление

    Swift

    optional func widgetDidBeginEditing()

    Objective C

    - (void)widgetDidBeginEditing

    Обсуждение

    Этот метод можно вызвать когда widgetAllowsEditing YEStrue.

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

    Objective C

    @import NotificationCenter;

    Swift

    import NotificationCenter

    Доступность

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

  • widgetDidEndEditing () - widgetDidEndEditing

    Вызванный, когда заканчивается сеанс редактирования виджета.

    Объявление

    Swift

    optional func widgetDidEndEditing()

    Objective C

    - (void)widgetDidEndEditing

    Обсуждение

    Этот метод вызывают, когда пользователь выбирает кнопку редактирования конца виджета или когда редактирование деактивировано, потому что редактирование начинается в различном виджете. Этот метод можно вызвать когда widgetAllowsEditing YEStrue.

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

    Objective C

    @import NotificationCenter;

    Swift

    import NotificationCenter

    Доступность

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

Константы
  • Коды результата обновления

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

    Объявление

    Swift

    enum NCUpdateResult : UInt { case NewData case NoData case Failed }

    Objective C

    typedef enum : NSUInteger { NCUpdateResultNewData, NCUpdateResultNoData, NCUpdateResultFailed } NCUpdateResult;

    Константы

    • NewData

      NCUpdateResultNewData

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

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

    • NoData

      NCUpdateResultNoData

      Обновление не приводило ни к каким новым данным начиная с последнего обновления.

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

    • Failed

      NCUpdateResultFailed

      Попытка обновления перестала работать.

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

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

    Objective C

    @import NotificationCenter;

    Swift

    import NotificationCenter

    Доступность

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