Protocol

ReferenceFileDocument

A document model definition used to serialize reference type documents to and from file contents. ある書類モデル定義、リファレンス型書類をファイル内容へとそしてそれからシリアル化するために使われます。

Declaration 宣言 

protocol ReferenceFileDocument : ObservableObject

Overview 概要

Conformance to ReferenceFileDocument is expected to be thread-safe, and deserialization and serialization will be done on a background thread.

Topics 話題

Reading a Document

init(configuration: Self.ReadConfiguration) throws
Initialize self by reading from the contents of a given ReadConfiguration.

Required. 必須。

static var readableContentTypes: [UTType]
The types the document is able to open.

Required. 必須。

typealias ReadConfiguration
The configuration for reading document contents.

Getting a Snapshot

func snapshot(contentType: UTType) throws -> Self.Snapshot
Create a snapshot of the current state of the document, which will be used for serialization while self becomes editable by the user.

Required. 必須。

associatedtype Snapshot
A type of the document snapshot that can be used for serialization in parallel to the main document being editable.

Required. 必須。

Writing a Document

func fileWrapper(snapshot: Self.Snapshot, configuration: Self.WriteConfiguration) throws -> FileWrapper
Serialize the snapshot to file contents for a specified type.

Required. 必須。

static var writableContentTypes: [UTType]
The types the document is able to save or export to.

Required. Default implementation provided. 必須。 提供される省略時の実装。

typealias WriteConfiguration
The configurations for serializing document contents.

Relationships 関係

Inherits From 継承元

See Also 参照

Reference Type Documents

struct ReferenceFileDocumentConfiguration
The properties of an open reference file document. あるオープンリファレンスファイル書類のプロパティ。