PTDocumentModel

@protocol PTDocumentModel <NSObject>

A protocol that defines the interface of a document model object.

  • The string that uniquely identifies this document.

    Declaration

    Objective-C

    @required
    @property (nonatomic, copy, readonly, nullable) NSString *identifier;

    Swift

    var identifier: String? { get }
  • The number of pages in the modelled PDF document.

    Declaration

    Objective-C

    @required
    @property (nonatomic, assign, unsafe_unretained, readonly) int pageCount;

    Swift

    var pageCount: Int32 { get }
  • The filename of the modelled PDF document.

    Declaration

    Objective-C

    @required
    @property (nonatomic, copy, readonly, nullable) NSString *filename;

    Swift

    var filename: String? { get }
  • The set of page model objects for this document.

    Declaration

    Objective-C

    @required
    @property (nonatomic, copy, readonly, nullable) NSSet<id<PTPageModel>> *pages;

    Swift

    var pages: Set<AnyHashable>? { get }
  • The set of all annotation model objects in this document.

    Declaration

    Objective-C

    @required
    @property (nonatomic, copy, readonly, nullable)
        NSSet<id<PTAnnotationModel>> *annotations;

    Swift

    var annotations: Set<AnyHashable>? { get }
  • The annotation author model objects for this document.

    Declaration

    Objective-C

    @required
    @property (nonatomic, copy, readonly, nullable)
        NSSet<id<PTAnnotationAuthorModel>> *authors;

    Swift

    var authors: Set<AnyHashable>? { get }