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

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

Разработчик

Ссылка платформы основы ссылка класса NSProgress

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

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

NSProgress

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

Создание отчетов о прогрессе

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

Объекты прогресса имеют много свойств, которые можно использовать, чтобы наблюдать и сообщить о текущем прогрессе. Например, totalUnitCount свойство представляет общее количество единиц работы, которые должны быть выполнены, и completedUnitCount и fractionCompleted свойства представляют, сколько из той работы было уже завершено. fractionCompleted свойство полезно для обновления индикаторов хода выполнения или текстовых дескрипторов; чтобы проверить, завершен ли прогресс, необходимо протестировать это completedUnitCount >= totalUnitCount (принятие, конечно, это totalUnitCount > 0).

Следующее перечисление показывает выборочный метод, сообщающий о прогрессе выполнения некоторой работы на части данных. Когда объект прогресса сначала создается, значение totalUnitCount свойство установлено в некоторый подходящий объем партии для этой работы, и completedUnitCount количество 0. Каждый раз цикл выполняется, и пакет данных обрабатывается, объект прогресса totalUnitCount свойство постепенно увеличивается соответственно.

  • - (void)startTaskWithData:(NSData *)data {
  • NSUInteger batchSize = ... use a suitable batch size
  • NSProgress *progress = [NSProgress progressWithTotalUnitCount:batchSize];
  • for (NSUInteger index = 0; index < batchSize; index++) {
  • // Check for cancellation
  • if ([progress isCancelled]) {
  • // Tidy up as necessary...
  • break;
  • }
  • // Do something with this batch of data...
  • // Report progress (add 1 because we've completed the work for the current index).
  • [progress setCompletedUnitCount:(index + 1)];
  • }
  • }

Каждое из свойств объекта прогресса, включая totalUnitCount, completedUnitCount, и fractionCompleted, поддерживайте Наблюдение Значения ключа. Когда значения изменяются, это делает его чрезвычайно простым для представления или объекта контроллера окна наблюдать свойства и обновить элементы UI, такие как индикаторы хода выполнения. Это также означает, что существует ненулевая стоимость для обновления значений этих свойств, таким образом, необходимо избегать использования количества модуля, которое слишком гранулировано — если Вы выполняете итерации по большому набору данных, например, и каждая работа занимает только тривиальное количество времени, необходимо разделить работу на пакеты, таким образом, можно обновить количество модуля один раз на пакет, а не один раз на итерацию.

Создание дерева объектов прогресса

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

NSProgress создание отчетов о механизме поддерживает слабо связанное отношение между объектами прогресса. Подоперации ничего не должны знать о родительском элементе прогресса — можно просто создать новые объекты прогресса и, если другой NSProgress экземпляр уже существует и отмечен как являющийся текущим для текущего потока, новые объекты будут установлены как дочерние элементы того экземпляра. Когда дочерние элементы завершаются, родитель completedUnitCount свойство автоматически увеличено предопределенной суммой.

Как пример, полагайте отслеживание прогресса кода загружающие и копирующие файлы на диске. Вы могли использовать единственный объект прогресса отследить всю задачу, но проще управлять каждой подзадачей с помощью отдельного объекта прогресса. Вы запускаете путем создания полного родительского объекта прогресса с подходящим общим количеством модуля, затем вызываете becomeCurrentWithPendingUnitCount:, тогда создайте свои объекты прогресса подзадачи перед окончательным вызовом resignCurrent.

Незаконченное количество модуля, которое Вы указываете в первом методе, разделено одинаково между дочерними объектами прогресса, которые что Вы создаете между этими двумя вызовами метода. Каждый дочерний объект прогресса поддерживает свое собственное внутреннее количество модуля, но когда он завершает свои модули (т.е. дочерний объект completedUnitCount == totalUnitCount), родительский объект прогресса completedUnitCount увеличен присвоенной частью исходного незаконченного количества модуля.

В следующем примере полный родительский прогресс имеет 100 модулей; эти два дочерних объекта поэтому получают 50 незаконченных модулей каждый и отслеживают внутренне 10 единиц работы каждого. Когда каждый дочерний элемент завершает его 10 модулей, завершенное количество модуля родителя увеличено на 50.

  • - (void)startLongOperation {
  • self.overallProgress = [NSProgress progressWithTotalUnitCount:100];
  • [self.overallProgress becomeCurrentWithPendingUnitCount:50];
  • [self work1];
  • [self.overallProgress resignCurrent];
  • [self.overallProgress becomeCurrentWithPendingUnitCount:50];
  • [self work2];
  • [self.overallProgress resignCurrent];
  • }
  • - (void)work1 {
  • NSProgress *firstTaskProgress = [NSProgress progressWithTotalUnitCount:10];
  • // Perform first task...
  • }
  • - (void)work2 {
  • NSProgress *secondTaskProgress = [NSProgress progressWithTotalUnitCount:10];
  • // Perform second task...
  • }

Если Вы не создаете дочерних объектов прогресса между вызовами к becomeCurrentWithPendingUnitCount: и resignCurrent, «родительский» прогресс автоматически обновляет completedUnitCount путем добавления незаконченных модулей.

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

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

Создание объектов прогресса
  • init (parent:userInfo:) - initWithParent:userInfo: Определяемый инициализатор

    Инициализирует недавно выделенный NSProgress экземпляр.

    Объявление

    Swift

    init(parent parentProgressOrNil: NSProgress?, userInfo userInfoOrNil: [NSObject : AnyObject]?)

    Objective C

    - (instancetype)initWithParent:(NSProgress *)parentProgressOrNil userInfo:(NSDictionary *)userInfoOrNil

    Параметры

    parentProgressOrNil

    Родитель NSProgress объект, если таковые имеются, чтобы уведомить при создании отчетов о прогрессе или консультироваться при проверке на отмену.

    Единственные допустимые значения [NSProgress currentProgress] или nil.

    userInfoOrNil

    Словарь информации о пользователе для объекта прогресса. Может быть nil.

    Обсуждение

    Это - определяемый инициализатор для NSProgress класс.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (totalUnitCount:) + progressWithTotalUnitCount:

    Создает и возвращается NSProgress экземпляр, инициализированное использование initWithParent:userInfo:.

    Объявление

    Swift

    init(totalUnitCount unitCount: Int64) -> NSProgress

    Objective C

    + (NSProgress *)progressWithTotalUnitCount:(int64_t)unitCount

    Параметры

    unitCount

    Общее количество единиц работы, которые будут выполнены.

    Обсуждение

    Если существует один, и значение, инициализатор передается текущий объект прогресса totalUnitCount свойство установлено.

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

    Можно вызвать этот метод на один поток и затем передать возвращенный NSProgress на другом потоке. Например, можно получить создаваемый экземпляр прогресса в блоке, которому Вы передаете dispatch_async(3) Mac OS X Developer Tools Manual Page. В том блоке можно вызвать методы как becomeCurrentWithPendingUnitCount: или resignCurrent, и набор completedUnitCount или cancelled свойства как работа выполняются.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Текущий объект прогресса
  • currentProgress () + currentProgress

    Возвраты NSProgress экземпляр, если таковые имеются, связался с текущим потоком предыдущим вызовом becomeCurrentWithPendingUnitCount:.

    Объявление

    Swift

    class func currentProgress() -> NSProgress?

    Objective C

    + (NSProgress *)currentProgress

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

    NSProgress экземпляр связался с текущим потоком, если таковые имеются.

    Обсуждение

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

    При создании отчетов о прогрессе Вы обычно работаете с дочерним объектом прогресса, создаваемым путем вызова progressWithTotalUnitCount:, гарантировать, чтобы Вы сообщили о прогрессе известных единиц работы.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • becomeCurrentWithPendingUnitCount (_:) - becomeCurrentWithPendingUnitCount:

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

    Объявление

    Swift

    func becomeCurrentWithPendingUnitCount(_ unitCount: Int64)

    Objective C

    - (void)becomeCurrentWithPendingUnitCount:(int64_t)unitCount

    Параметры

    unitCount

    Число единиц работы, которые будут выполнены следующим объектом прогресса, инициализирующимся путем вызова initWithParent:userInfo: метод в текущем потоке с набором получателя как родитель. Это число представляет часть работы, которая будет выполняться в связи с общим количеством единиц работы, которые будут выполняться получателем (представленный значением получателя totalUnitCount свойство). Единицы работы, представленные этим параметром, должны быть теми же единицами работы, использующимися в получателе totalUnitCount свойство.

    Обсуждение

    Используйте этот метод для создания дерева объектов прогресса, как описано в Создании Дерева Объектов Прогресса.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • resignCurrent () - resignCurrent

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

    Объявление

    Swift

    func resignCurrent()

    Objective C

    - (void)resignCurrent

    Обсуждение

    Используйте этот метод после создания Вашего дерева объектов прогресса, как описано в Создании Дерева Объектов Прогресса.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Создание отчетов о прогрессе
  • totalUnitCount totalUnitCount Свойство

    Общее количество единиц работы прослежено для текущего прогресса.

    Объявление

    Swift

    var totalUnitCount: Int64

    Objective C

    @property int64_t totalUnitCount

    Обсуждение

    Для NSProgress со своего рода NSProgressKindFile, модуль этого свойства является байтами в то время как NSProgressFileTotalCountKey и NSProgressFileCompletedCountKey ключи userInfo словарь используется для полного количества файлов.

    Для любого другого отчасти NSProgress, единица измерения не имеет значения, пока это является непротиворечивым. О значениях можно сообщить пользователю в localizedDescription и localizedAdditionalDescription.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    fractionCompleted

  • completedUnitCount completedUnitCount Свойство

    Число уже завершенных единиц работы для текущего задания.

    Объявление

    Swift

    var completedUnitCount: Int64

    Objective C

    @property int64_t completedUnitCount

    Обсуждение

    Для NSProgress со своего рода NSProgressKindFile, модуль этого свойства является байтами в то время как NSProgressFileTotalCountKey и NSProgressFileCompletedCountKey ключи userInfo словарь используется для полного количества файлов.

    Для любого другого отчасти NSProgress, единица измерения не имеет значения, пока это является непротиворечивым. О значениях можно сообщить пользователю в localizedDescription и localizedAdditionalDescription.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    fractionCompleted

  • localizedDescription localizedDescription Свойство

    Локализованное описание прогресса прослежено получателем.

    Объявление

    Swift

    var localizedDescription: String

    Objective C

    @property(copy) NSString *localizedDescription

    Обсуждение

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

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

    • Копирование 10 файлов …

    • 30% завершились

    • Копирование «TextEdit» …

    По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    localizedAdditionalDescription

  • localizedAdditionalDescription localizedAdditionalDescription Свойство

    Более определенное локализованное описание прогресса прослежено получателем.

    Объявление

    Swift

    var localizedAdditionalDescription: String

    Objective C

    @property(copy) NSString *localizedAdditionalDescription

    Обсуждение

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

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

    • 3 из 10 файлов

    • 123 КБ 789,1 МБ

    • 3.3 MB минут на 103,92 ГБ - 2, оставаясь

    • 1,61 ГБ минут (на 2 кБайт/с) - 2 на 3,22 ГБ, оставаясь

    • 1 минута, оставаясь (1 кБайт/с)

    По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    localizedDescription

Наблюдение прогресса
  • fractionCompleted fractionCompleted Свойство

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

    Объявление

    Swift

    var fractionCompleted: Double { get }

    Objective C

    @property(readonly) double fractionCompleted

    Обсуждение

    Если объект получателя не имеет никаких дочерних элементов, fractionCompleted обычно результат деления completedUnitCount totalUnitCount.

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Управление прогрессом
  • отменимый отменимый Свойство

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

    Объявление

    Swift

    var cancellable: Bool

    Objective C

    @property(getter=isCancellable) BOOL cancellable

    Обсуждение

    По умолчанию, NSProgress объекты являются отменимыми.

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

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

    Это допустимо для значения этого свойства для изменения во время времени жизни NSProgress объект. По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – отмена
    отмененный

  • отмененный отмененный Свойство

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

    Объявление

    Swift

    var cancelled: Bool { get }

    Objective C

    @property(readonly, getter=isCancelled) BOOL cancelled

    Обсуждение

    По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

    Если получатель будет иметь родителя, уже отмененного, то получатель также сообщит о том, чтобы быть отмененным.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – отмена
    отменимый

  • отмена () - отмена

    Отслеживание прогресса отмены.

    Объявление

    Swift

    func cancel()

    Objective C

    - (void)cancel

    Обсуждение

    Этот метод вызывает блочный набор для cancellationHandler, если существует один и гарантирует что какие-либо последующие чтения cancelled возврат свойства YEStrue.

    Если получатель будет иметь какие-либо дочерние элементы, то те дочерние элементы будут также отменены.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • cancellationHandler cancellationHandler Свойство

    Блок для вызова, когда отменяется прогресс.

    Объявление

    Swift

    var cancellationHandler: (() -> Void)?

    Objective C

    @property(copy) void (^cancellationHandler)(void)

    Обсуждение

    Если получатель является дочерним элементом другого объекта прогресса, cancellationHandler когда родитель будет отменен, блок будет вызван.

    Специальные замечания

    Обработчик отмены может быть вызван на любую очередь. Если необходимо выполнить работу на определенной очереди, необходимо диспетчеризировать той очереди из блока обработчика отмены.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • pausable pausable Свойство

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

    Объявление

    Swift

    var pausable: Bool

    Objective C

    @property(getter=isPausable) BOOL pausable

    Обсуждение

    По умолчанию, NSProgress объекты не pausable.

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

    Если NSProgress pausable, необходимо реализовать возможность приостановить любого путем установки блока для pausingHandler свойство, или путем опроса paused свойство периодически при выполнении соответствующей работы.

    Это допустимо для значения этого свойства для изменения во время времени жизни NSProgress объект. По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • приостановленный приостановленный Свойство

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

    Объявление

    Swift

    var paused: Bool { get }

    Objective C

    @property(readonly, getter=isPaused) BOOL paused

    Обсуждение

    По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • пауза () - пауза

    Отслеживание прогресса паузы.

    Объявление

    Swift

    func pause()

    Objective C

    - (void)pause

    Обсуждение

    Этот метод вызывает блочный набор для pausingHandler, если существует один и гарантирует что какие-либо последующие чтения paused возврат свойства YEStrue.

    Если получатель будет иметь какие-либо дочерние элементы, то те дочерние элементы будут также приостановлены.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • pausingHandler pausingHandler Свойство

    Блок для вызова, когда приостанавливается прогресс.

    Объявление

    Swift

    var pausingHandler: (() -> Void)?

    Objective C

    @property(copy) void (^pausingHandler)(void)

    Обсуждение

    Если получатель является дочерним элементом другого объекта прогресса, pausingHandler когда родитель будет приостановлен, блок будет вызван.

    Специальные замечания

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Информация о прогрессе
  • неопределенный неопределенный Свойство

    Указывает, неопределенен ли отслеженный прогресс. (только для чтения)

    Объявление

    Swift

    var indeterminate: Bool { get }

    Objective C

    @property(readonly, getter=isIndeterminate) BOOL indeterminate

    Обсуждение

    Прогресс неопределенен когда значение также totalUnitCount или completedUnitCount меньше, чем нуль.

    Установка обоих totalUnitCount и completedUnitCount свойства для обнуления указывают, что нет никакого прогресса для отслеживания; в этом случае, isIndeterminate возвраты NOfalse и fractionCompleted возвраты 1.0.

    По умолчанию, NSProgress KVO-совместимо для этого свойства, отправляя уведомления на том же потоке, обновляющем свойство.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • вид вид Свойство

    Строка, идентифицирующая вид сделанных успехов.

    Объявление

    Swift

    var kind: String?

    Objective C

    @property(copy) NSString *kind

    Обсуждение

    Это свойство идентифицирует вид сделанных успехов, такой как NSProgressKindFile. Это может быть nil.

    Если значение localizedDescription свойство не было ранее установлено в ненулевое значение, значение по умолчанию localizedDescription метод get использует вид прогресса, чтобы определить, как использовать значения других свойств, а также значения в пользовательском информационном словаре, для создания строки, которая презентабельна пользователю.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    localizedDescription

  • setUserInfoObject (_: forKey:) - setUserInfoObject:forKey:

    Установите значение в userInfo словарь.

    Объявление

    Swift

    func setUserInfoObject(_ objectOrNil: AnyObject?, forKey key: String)

    Objective C

    - (void)setUserInfoObject:(id)objectOrNil forKey:(NSString *)key

    Параметры

    objectOrNil

    Объект установить для данного ключа, или nil удалить существующую запись в словаре.

    key

    Ключ для использования, чтобы хранить данный объект.

    Обсуждение

    Используйте этот метод для установки значения в userInfo словарь, с надлежащим уведомлением KVO для свойств, значения которых могут зависеть от значений в пользовательском информационном словаре, как localizedDescription.

    Предоставьте значение nil удалить существующую словарную статью для данного ключа.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • userInfo userInfo Свойство

    Словарь произвольных значений связался с получателем. (только для чтения)

    Объявление

    Swift

    var userInfo: [NSObject : AnyObject]? { get }

    Objective C

    @property(readonly, copy) NSDictionary *userInfo

    Обсуждение

    KVO-совместимый словарь, изменяющийся в ответ на setUserInfoObject:forKey:. Словарь отправляет все свои уведомления KVO на потоке, обновляющем свойство.

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Константы
  • Общие пользовательские информационные ключи словаря прогресса

    Набор оценивает за эти ключи в пользовательском информационном словаре для влияния на автоматически сгенерированный localizedAdditionalDescription строка.

    Объявление

    Swift

    let NSProgressEstimatedTimeRemainingKey: NSString! let NSProgressThroughputKey: NSString!

    Objective C

    NSString *const NSProgressEstimatedTimeRemainingKey; NSString *const NSProgressThroughputKey;

    Константы

    • NSProgressEstimatedTimeRemainingKey

      NSProgressEstimatedTimeRemainingKey

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

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

    • NSProgressThroughputKey

      NSProgressThroughputKey

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

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

  • Виды прогресса

    При работе с файлами, набор эта строка для kind из прогресса.

    Объявление

    Swift

    let NSProgressKindFile: NSString!

    Objective C

    NSString *const NSProgressKindFile;

    Константы

    • NSProgressKindFile

      NSProgressKindFile

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

      NSProgress из этого вида, как предполагается, использует байты в качестве единицы работы, сделанной, и реализация по умолчанию localizedDescription использует в своих интересах это для возврата более определенного текста, чем он мог иначе. NSProgressFileTotalCountKey и NSProgressFileCompletedCountKey ключи userInfo словарь используется для полного количества файлов.

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

  • Информационные ключи словаря пользователя системы эксплуатации файла

    Набор оценивает за эти ключи в пользовательском информационном словаре для предоставления большей информации об операциях файла для автоматически сгенерированного localizedDescription и localizedAdditionalDescription строки.

    Объявление

    Swift

    let NSProgressFileOperationKindKey: NSString! let NSProgressFileTotalCountKey: NSString! let NSProgressFileCompletedCountKey: NSString!

    Objective C

    NSString *const NSProgressFileOperationKindKey; NSString *const NSProgressFileTotalCountKey; NSString *const NSProgressFileCompletedCountKey;

    Константы

    • NSProgressFileOperationKindKey

      NSProgressFileOperationKindKey

      Значение требуется для этого ключа в пользовательском информационном словаре когда прогресс kind установлен в NSProgressKindFile. Соответствующее значение должно быть одной из записей, перечисленных в “File operation kinds”.

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

    • NSProgressFileTotalCountKey

      NSProgressFileTotalCountKey

      Соответствующее значение должно быть NSNumber содержа целое число для представления общего количества затронутых файлов. Эта запись является дополнительной; если Вы устанавливаете значение для этого ключа, автоматически сгенерированного localizedAdditionalDescription строка использует его.

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

    • NSProgressFileCompletedCountKey

      NSProgressFileCompletedCountKey

      Соответствующее значение должно быть NSNumber содержа целое число для представления числа завершенных файлов. Эта запись является дополнительной; если Вы устанавливаете значение для этого ключа, автоматически сгенерированного localizedAdditionalDescription строка использует его.

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

  • Виды работы файла

    При отслеживании операций файла с прогрессом kind набор к NSProgressKindFile, необходимо обеспечить значение для NSProgressFileOperationKindKey в пользовательском информационном словаре. Существует четыре возможных значения.

    Объявление

    Swift

    let NSProgressFileOperationKindDownloading: NSString! let NSProgressFileOperationKindDecompressingAfterDownloading: NSString! let NSProgressFileOperationKindReceiving: NSString! let NSProgressFileOperationKindCopying: NSString!

    Objective C

    NSString *const NSProgressFileOperationKindDownloading; NSString *const NSProgressFileOperationKindDecompressingAfterDownloading; NSString *const NSProgressFileOperationKindReceiving; NSString *const NSProgressFileOperationKindCopying;

    Константы

    • NSProgressFileOperationKindDownloading

      NSProgressFileOperationKindDownloading

      Прогресс отслеживает работу загрузки файла.

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

    • NSProgressFileOperationKindDecompressingAfterDownloading

      NSProgressFileOperationKindDecompressingAfterDownloading

      Прогресс отслеживает распаковку файла после загрузки.

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

    • NSProgressFileOperationKindReceiving

      NSProgressFileOperationKindReceiving

      Прогресс отслеживает получение файла из другого источника.

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

    • NSProgressFileOperationKindCopying

      NSProgressFileOperationKindCopying

      Прогресс отслеживает копирование файла от источника до места назначения.

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