An object that builds PSPDFAnnotationMenuConfiguration.

The default implementation for the style manager.

Default implementation that forwards calls to the app delegate.

Default extension implementation that interacts and requires an NSExtensionContext to work.

The default security auditor simply returns YES for every request.

Base class for building a configuration object.

Undocumented

A color patch represents a single patch of colors in the UI. It contains of one or multiple colors that should be grouped together.

A color palette is a set of color patches that are grouped together based on a specific look or theme.

The factory used to create color pickers. Subclass this to customize your color pickers.

An object that can be used to build comparison processor configuration objects.

Undocumented

Represents a page size option for new pages.

Define a compression used for image compression.

Undocumented

Undocumented

This configuration builder offers all properties of PSPDFDragAndDropConfiguration in a writable version.

Used to configure various drag and drop options, on how and where it should work. Set the object you create here on PSPDFConfiguration.dragAndDropConfiguration.

The default file manager implementation is a thin wrapper around NSFileManager.

The gallery configuration builder object offers all properties of PSPDFGalleryConfiguration in a writable version, in order to build an immutable PSPDFGalleryConfiguration object.

Undocumented

Undocumented

A ratio of a distance on a document page to a corresponding real world distance.

A known real world distance used for calibration to obtain a MeasurementScale.

Measurement info object used to store details of a measurement annotation.

An abstract base class for model objects, using reflection to provide sensible default behaviors.

The default implementations of , -hash, and -isEqual: make use of the +propertyKeys method.

Thread safe implementation of the network activity indicator protocol.

Undocumented

Undocumented

The mutual version of a render request can be used to configure it so that it matches the desired request.

An abstract class for a controller that manages a table view with search functionality.

This configuration builder offers all properties of PSPDFSignatureAppearance in a writable version.

Mutable builder for configuration options for PSPDFSignatureCreationViewController.

A signature store implementation that securely loads from, and saves to, the system keychain.

Represents a single HUD item.

Status HUD view that represents a given status HUD item.

Simple subclass that disables animations during layoutSubviews if the popover is being resized. This fixes an unexpected animation when the tableView is updated while a popover resizes.

Never allows animations during layoutSubviews.

Layout attributes for the thubmnail collection view.

Subclass to enable UIAppearance rules on the filter.

Buttons that can be used as spacers for the toolbar (similar to UIBarButtonSystemItemFlexibleSpace and UIBarButtonSystemItemFixedSpace). Does not allow user interaction and is not visible, but takes up space on the toolbar. Use the properties described under “Metrics” form PSPDFToolbarButton for sizing.

Sends out PSPDFControlEventTick events while the button is pressed.

A custom spacer button that visually separates button groups.

Undocumented

Toolbar button that shows a light gray rounded border.

PSPDFToolbarButton with a grouping disclosure indicator.

PSPDFToolbarButton that combines two buttons into one.

Special PSPDFToolbarGroupButton used for the collapsed button item.

Empty subclass for easier debugging.

The URLDataProvider manages automatic downloading of a file.

By default, downloads will use URLCache to cache downloads. The downloaded file is stored in a tmp directory (purged automatically by the system) while the cache is stored in the Caches directory (preserved except on low disk events)

If a custom targetURL is set and a file exists at this location, no download will be attempted. To ensure that the file is always up-to-date, delete the file at targetURL before allocating this class.

This class starts downloading the file as soon as it is initialized.

PSPDF_EXPORT(PSPDFURLDataProvider)

An annotation set store that saves annotation sets in the Keychain.

PSPDF_EXPORT(PSPDFKeychainAnnotationSetsStore)

An annotation set store that stores the saved annotation sets on disk, using file protection.

PSPDF_EXPORT(PSPDFPersistentAnnotationSetStore)

A view controller that provides the user interface for aligning two versions of a document.

Customizing the Document Alignment View Controller

The document alignment view controller’s view hierarchy uses tintColor to configure the look of the crosshair and the progress bar. You can customize this look by setting a custom tint color.

You may use ComparisonConfiguration to customize the contents and the look of the generated comparison document. See its documentation for more information.

Receiving the Generated Comparison Document

Once the user aligns both versions of a document, the document alignment view controller will notify the delegate object that a comparison document was generated, or failed to be generated because of an error. You may implement the two methods to hide the document alignment view controller and update your app’s user interface accordingly.

The document alignment view controller also offers an alternative Swift-only API based on the Combine framework that you can use to receive the generated comparison document. It’s equivalent to the delegate protocol and may be used when Combine bindings are more manageable, e.g. in SwiftUI.

PSPDF_EXPORT(PSPDFDocumentAlignmentViewController)

A button that you can add to your user interface to allow users to initiate the document alignment process.

Displaying the Document Alignment Button

The document alignment button can be added to the userInterfaceView of your PDF view controller, or to any other view in your app.

let button = DocumentAlignmentButton()
pdfViewController.userInterfaceView.addSubview(button)
NSLayoutConstraint.activate([...])

Customizing the Document Alignment Button

To customize the title and the image used in the document alignment button, use the standard setTitle(_:for:) and setImage(_:for:) functions of the UIButton class. The document alignment button also provides a convenience init(title:image:) initializer that does this automatically.

The document alignment button uses tintColor as its background color and foregroundColor as the color of the title and the image. By default, the document alignment button chooses a foreground color such that is has the highest possible contrast with the tint color.

PSPDF_EXPORT(PSPDFDocumentAlignmentButton)

A signature creation view controller can be used to add a signature to a document by drawing, selecting an image, or typing.

This class requires the Electronic Signatures feature to be enabled in your license.

To cryptographically sign a document with a certificate, please use the PDFSigner class from PSPDFKit’s Digital Signatures component.

Check out https://pspdfkit.com/guides/ios/signatures/overview/ for more general information about signatures.

PSPDF_EXPORT(PSPDFSignatureCreationViewController)

Base class that helps to build standalone delegate handlers. Class will live as long as bound target lives. Automatically forwards non-implemented delegate overrides to the originalDelegate, if one is set.

class DocumentSharingDelegateHandler: StandaloneDelegate<PDFDocumentSharingViewControllerDelegate>, PDFDocumentSharingViewControllerDelegate {
    (your delegate implementations)
}

// The `StandaloneDelegateContainer` will automatically manage the lifetime of this helper.
// It will be deallocated as soon as sharingController is deallocated.
let handler = DocumentSharingHandler(delegateTarget: sharingController, originalDelegate: sharingController.delegate)
sharingController.delegate = handler