Structure

ProgressUserInfoKey

Keys for the user info dictionary that affect the autogenerated localized additional description string. ユーザ情報辞書に対するキーいくつか、それらは自動生成されるローカライズされた追加記述文字列に影響を及ぼすものです。

Declaration 宣言 

struct ProgressUserInfoKey, @unchecked Sendable

Overview 概要

Enhance the autogenerated description that localizedAdditionalDescription provides by including keys and related values in the user info dictionary. For example, if you provide the keys fileCompletedCountKey and fileTotalCountKey, the localizedAdditionalDescription method uses the values from those keys to provide strings showing the number of completed and total files.

Topics 話題

Creating Keys

init(String)
Creates a new key using the specified string.
init(rawValue: String)
Creates a new key using the raw value of a string you specify.

Using General Keys

static let estimatedTimeRemainingKey: ProgressUserInfoKey
A key with a corresponding value that represents the time remaining, in seconds.
static let throughputKey: ProgressUserInfoKey
A key with a corresponding value that indicates the speed of data processing, in bytes per second.

Using File Operation Keys

static let fileAnimationImageKey: ProgressUserInfoKey
A key with a corresponding value that is an image, typically an icon to represent the file. ある対応している値を備えるあるキー、それはある画像、概してファイルを表すアイコンです。
static let fileAnimationImageOriginalRectKey: ProgressUserInfoKey
A key with a corresponding value that indicates the starting location of the image onscreen.
static let fileCompletedCountKey: ProgressUserInfoKey
A key with a corresponding value that represents the number of completed files.
static let fileIconKey: ProgressUserInfoKey
A key with a corresponding value that must be an image, typically an icon to represent the file.
static let fileOperationKindKey: ProgressUserInfoKey
A key with a corresponding value that indicates the kind of file operation a progress object represents.
static let fileTotalCountKey: ProgressUserInfoKey
A key with a corresponding value that represents the total number of files within a file operation.
static let fileURLKey: ProgressUserInfoKey
A key with a corresponding value that represents the file URL of a file operation for the progress object.

Relationships 関係

Conforms To 次に準拠

See Also 参照

Inspecting Progress Information 進捗情報を調査する

var kind: ProgressKind?
An object that represents the kind of progress for the progress object. あるオブジェクト、それはこの進捗オブジェクトに対する進捗の種類を表します。
var estimatedTimeRemaining: TimeInterval?
A value that indicates the estimated amount of time remaining to complete the progress. ある値、それはその進捗を完了するのに残っている概算の時間量を指し示します。
var throughput: Int?
A value that represents the speed of data processing, in bytes per second. ある値、それはデータ処理の速度を表します、バイト毎秒で。
func setUserInfoObject(Any?, forKey: ProgressUserInfoKey)
Sets a value in the user info dictionary. ユーザ情報辞書の中のある値を設定します。
var userInfo: [ProgressUserInfoKey : Any]
A dictionary of arbitrary values for the receiver. レシーバに対する随意の値それらからなるある辞書。
struct ProgressKind
An object that represents the kind of progress. あるオブジェクト、それは進捗の種類を表します。