Other Classes
The following classes are available globally.
-
An object that builds
See morePSPDFAnnotationMenuConfiguration
.Declaration
Objective-C
@interface PSPDFAnnotationMenuConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class Builder : BaseConfigurationBuilder
-
The default implementation for the style manager.
See moreDeclaration
Objective-C
@interface PSPDFDefaultAnnotationStyleManager : NSObject <PSPDFAnnotationStyleManager>
Swift
class PDFDefaultAnnotationStyleManager : NSObject, AnnotationStyleManager
-
Default implementation that forwards calls to the app delegate.
Declaration
Objective-C
@interface PSPDFDefaultApplication : NSObject <PSPDFApplication>
Swift
class DefaultApplication : NSObject, Application
-
Default extension implementation that interacts and requires an
See moreNSExtensionContext
to work.Declaration
Objective-C
@interface PSPDFExtensionApplication : PSPDFDefaultApplication <PSPDFApplication>
Swift
class ExtensionApplication : DefaultApplication, Application
-
The default security auditor simply returns YES for every request.
Declaration
Objective-C
@interface PSPDFDefaultApplicationPolicy : NSObject <PSPDFApplicationPolicy>
Swift
class DefaultApplicationPolicy : NSObject, ApplicationPolicy
-
Base class for building a configuration object.
See moreDeclaration
Objective-C
@interface PSPDFBaseConfigurationBuilder : NSObject
Swift
class BaseConfigurationBuilder : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFMutableBookmark : PSPDFBookmark
Swift
class MutableBookmark : Bookmark
-
An object that can be used to build comparison processor configuration objects.
See moreDeclaration
Objective-C
@interface PSPDFComparisonConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class Builder : BaseConfigurationBuilder
-
Declaration
Objective-C
@interface PSPDFConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class PDFConfigurationBuilder : BaseConfigurationBuilder
-
An object that builds
See morePSPDFContentMenuConfiguration
.Declaration
Objective-C
@interface PSPDFContentMenuConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class Builder : BaseConfigurationBuilder
-
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFDocumentEditorConfigurationBuilder : PSPDFBaseConfigurationBuilder
-
Represents a page size option for new pages.
See more -
Define a compression used for image compression.
See moreDeclaration
Objective-C
@interface PSPDFCompression : PSPDFModel
Swift
class Compression : ModelObject
-
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFDocumentSharingConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class DocumentSharingConfigurationBuilder : BaseConfigurationBuilder
-
Undocumented
Declaration
Objective-C
@interface PSPDFDocumentViewLayoutInvalidationContext : UICollectionViewLayoutInvalidationContext @end
Swift
class PSPDFDocumentViewLayoutInvalidationContext : UICollectionViewLayoutInvalidationContext
-
This configuration builder offers all properties of
See morePSPDFDragAndDropConfiguration
in a writable version.Declaration
Objective-C
@interface PSPDFDragAndDropConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class DragAndDropConfigurationBuilder : BaseConfigurationBuilder
-
Used to configure various drag and drop options, on how and where it should work. Set the object you create here on
See morePSPDFConfiguration.dragAndDropConfiguration
.Declaration
Objective-C
@interface PSPDFDragAndDropConfiguration : PSPDFBaseConfiguration <PSPDFDragAndDropConfigurationBuilder *>
Swift
class DragAndDropConfiguration : BaseConfiguration<DragAndDropConfigurationBuilder>
-
The default file manager implementation is a thin wrapper around NSFileManager.
See moreDeclaration
Objective-C
@interface PSPDFDefaultFileManager : NSObject <PSPDFFileManager>
Swift
class DefaultFileManager : NSObject, FileManagerProtocol
-
The gallery configuration builder object offers all properties of
See morePSPDFGalleryConfiguration
in a writable version, in order to build an immutablePSPDFGalleryConfiguration
object.Declaration
Objective-C
@interface PSPDFGalleryConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class GalleryConfigurationBuilder : BaseConfigurationBuilder
-
Undocumented
Declaration
Objective-C
@interface PSPDFGalleryEmbeddedBackgroundView : UIView<PSPDFOverridable> @end
Swift
class GalleryEmbeddedBackgroundView : UIView, Overridable
-
Undocumented
Declaration
Objective-C
@interface PSPDFGalleryFullscreenBackgroundView : UIView<PSPDFOverridable> @end
Swift
class GalleryFullscreenBackgroundView : UIView, Overridable
-
A ratio of a distance on a document page to a corresponding real world distance.
See moreDeclaration
Objective-C
@interface PSPDFMeasurementScale : PSPDFModel
Swift
class MeasurementScale : ModelObject
-
A known real world distance used for calibration to obtain a
See moreMeasurementScale
.Declaration
Objective-C
@interface PSPDFMeasurementCalibration : NSObject
Swift
class MeasurementCalibration : NSObject
-
Measurement info object used to store details of a measurement annotation.
See moreDeclaration
Objective-C
@interface PSPDFMeasurementInfo : PSPDFModel
Swift
class MeasurementInfo : ModelObject
-
An abstract base class for model objects, using reflection to provide sensible default behaviors.
The default implementations of
See more, -hash, and -isEqual: make use of the +propertyKeys method. Declaration
Objective-C
@interface PSPDFModel : NSObject <NSCopying, NSSecureCoding>
Swift
class ModelObject : NSObject, NSCopying, NSSecureCoding
-
Thread safe implementation of the network activity indicator protocol.
Declaration
Objective-C
@interface PSPDFDefaultNetworkActivityIndicatorManager : NSObject <PSPDFNetworkActivityIndicatorManager>
Swift
class DefaultNetworkActivityIndicatorManager : NSObject, NetworkActivityIndicatorManager
-
Undocumented
Declaration
Objective-C
@interface PSPDFAnnotationContainerView : PSPDFRelayTouchesView <PSPDFOverridable>
Swift
class AnnotationContainerView : RelayTouchesView, Overridable
-
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFPrintConfigurationBuilder : PSPDFBaseConfigurationBuilder
Swift
class PrintConfigurationBuilder : BaseConfigurationBuilder
-
The mutual version of a render request can be used to configure it so that it matches the desired request.
See moreDeclaration
Objective-C
@interface PSPDFMutableRenderRequest : PSPDFRenderRequest
Swift
class MutableRenderRequest : RenderRequest
-
An abstract class for a controller that manages a table view with search functionality.
See moreDeclaration
Objective-C
@interface PSPDFSearchableTableViewController : PSPDFStatefulTableViewController
Swift
class SearchableTableViewController : StatefulTableViewController
-
This configuration builder offers all properties of
See morePSPDFSignatureAppearance
in a writable version.Declaration
Objective-C
@interface PSPDFSignatureAppearanceBuilder : PSPDFBaseConfigurationBuilder
Swift
class PDFSignatureAppearanceBuilder : BaseConfigurationBuilder
-
Mutable builder for configuration options for
See morePSPDFSignatureCreationViewController
.Declaration
Objective-C
@interface PSPDFSignatureCreationConfigurationBuilder : PSPDFBaseConfigurationBuilder
-
A signature store implementation that securely loads from, and saves to, the system keychain.
See moreDeclaration
Objective-C
@interface PSPDFKeychainSignatureStore : NSObject <PSPDFSignatureStore>
Swift
class KeychainSignatureStore : NSObject, SignatureStore
-
Declaration
Objective-C
@interface PSPDFStatusHUDItem : NSObject
Swift
class StatusHUDItem : NSObject
-
Status HUD view that represents a given status HUD item.
See moreDeclaration
Objective-C
@interface PSPDFStatusHUDView : UIView <PSPDFOverridable>
Swift
class StatusHUDView : UIView, Overridable
-
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.Declaration
Objective-C
@interface PSPDFNonAnimatingTableViewCell : PSPDFTableViewCell
Swift
class NonAnimatingTableViewCell : PDFTableViewCell
-
Never allows animations during
layoutSubviews
.Declaration
Objective-C
@interface PSPDFNeverAnimatingTableViewCell : PSPDFTableViewCell <PSPDFOverridable>
Swift
class NeverAnimatingTableViewCell : PDFTableViewCell, Overridable
-
Layout attributes for the thubmnail collection view.
See moreDeclaration
Objective-C
@interface PSPDFThumbnailFlowLayoutAttributes : UICollectionViewLayoutAttributes
Swift
class ThumbnailFlowLayoutAttributes : UICollectionViewLayoutAttributes
-
Subclass to enable
UIAppearance
rules on the filter.Declaration
Objective-C
@interface PSPDFThumbnailFilterSegmentedControl : UISegmentedControl <PSPDFOverridable>
Swift
class ThumbnailFilterSegmentedControl : UISegmentedControl, Overridable
-
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
See morePSPDFToolbarButton
for sizing.Declaration
Objective-C
@interface PSPDFToolbarSpacerButton : PSPDFToolbarButton
Swift
class ToolbarSpacerButton : ToolbarButton
-
Sends out
See morePSPDFControlEventTick
events while the button is pressed.Declaration
Objective-C
@interface PSPDFToolbarTickerButton : PSPDFToolbarButton
Swift
class ToolbarTickerButton : ToolbarButton
-
A custom spacer button that visually separates button groups.
See moreDeclaration
Objective-C
@interface PSPDFToolbarSeparatorButton : PSPDFToolbarSpacerButton
Swift
class ToolbarSeparatorButton : ToolbarSpacerButton
-
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFToolbarSelectableButton : PSPDFToolbarButton
Swift
class ToolbarSelectableButton : ToolbarButton
-
Toolbar button that shows a light gray rounded border.
Declaration
Objective-C
@interface PSPDFToolbarBorderButton : PSPDFToolbarButton
Swift
class ToolbarBorderButton : ToolbarButton
-
PSPDFToolbarButton with a grouping disclosure indicator.
See moreDeclaration
Objective-C
@interface PSPDFToolbarGroupButton : PSPDFToolbarButton <PSPDFOverridable>
Swift
class ToolbarGroupButton : ToolbarButton, Overridable
-
PSPDFToolbarButton that combines two buttons into one.
See moreDeclaration
Objective-C
@interface PSPDFToolbarDualButton : PSPDFToolbarButton
Swift
class ToolbarDualButton : ToolbarButton
-
Special
See morePSPDFToolbarGroupButton
used for the collapsed button item.Declaration
Objective-C
@interface PSPDFToolbarCollapsedButton : PSPDFToolbarGroupButton
Swift
class ToolbarCollapsedButton : ToolbarGroupButton
-
Empty subclass for easier debugging.
Declaration
Objective-C
@interface PSPDFDocumentLabelView : PSPDFLabelView <PSPDFOverridable>
Swift
class DocumentLabelView : PDFLabelView, Overridable
-
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 attargetURL
before allocating this class.This class starts downloading the file as soon as it is initialized.
PSPDF_EXPORT(PSPDFURLDataProvider)
See moreDeclaration
Swift
@objc(PSPDFURLDataProvider) public final class URLDataProvider : NSObject, DataProviding
-
An annotation set store that saves annotation sets in the Keychain.
Warning
The keychain store can safely store only up to 4 KB of data. This much data can be easily filled by storing a high-quality image annotation, a complex ink annotation or a sound annotation. As such, it’s recommended to usePersistentAnnotationSetStore
instead.PSPDF_EXPORT(PSPDFKeychainAnnotationSetsStore)
See moreDeclaration
Swift
@objc(PSPDFKeychainAnnotationSetsStore) open class KeychainAnnotationSetsStore : NSObject, AnnotationSetStore
-
An annotation set store that stores the saved annotation sets on disk, using file protection.
PSPDF_EXPORT(PSPDFPersistentAnnotationSetStore)
See moreDeclaration
Swift
@objc(PSPDFPersistentAnnotationSetStore) public final class PersistentAnnotationSetStore : NSObject, AnnotationSetStore
-
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)
See moreDeclaration
Swift
@objc(PSPDFDocumentAlignmentViewController) public final class DocumentAlignmentViewController : UIViewController
-
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:)
andsetImage(_:for:)
functions of theUIButton
class. The document alignment button also provides a convenienceinit(title:image:)
initializer that does this automatically.The document alignment button uses
tintColor
as its background color andforegroundColor
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.Warning
Don’t callsetTitleColor(_:for:)
or set thebackgroundColor
or theimageView.tintColor
properties directly. UsetintColor
andforegroundColor
instead.PSPDF_EXPORT(PSPDFDocumentAlignmentButton)
See more -
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)
See moreDeclaration
Swift
@objc(PSPDFSignatureCreationViewController) open class SignatureCreationViewController : UIViewController, Overridable
-
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.
See moreclass 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
Declaration
Swift
open class StandaloneDelegate<DelegateType> : NSObject where DelegateType : NSObjectProtocol