Install in Dash
Other Classes
The following classes are available globally.
-
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 moreNSExtensionContextto 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 : NSObjectSwift
class BaseConfigurationBuilder : NSObject -
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFMutableBookmark : PSPDFBookmarkSwift
class MutableBookmark : Bookmark -
A color patch represents a single patch of colors in the UI. It contains of one or multiple colors that should be grouped together.
See moreDeclaration
Objective-C
@interface PSPDFColorPatch : NSObjectSwift
class ColorPatch : NSObject -
A color palette is a set of color patches that are grouped together based on a specific look or theme.
See moreNote
Starting with iOS 14 PSPDFKit’s default UI will display the system color picker (UIColorPickerViewController) where possible. On macOS Big Sur and later the system color picker will also be used for select options (e.g. the highlight annotation menu). Customizing this API will have no effect on the system color picker.Declaration
Objective-C
@interface PSPDFColorPalette : NSObjectSwift
class ColorPalette : NSObject -
The factory used to create color pickers. Subclass this to customize your color pickers.
See moreNote
Starting with iOS 14 PSPDFKit’s default UI will display the system color picker (UIColorPickerViewController) where possible. On macOS Big Sur and later the system color picker will also be used for select options (e.g. the highlight annotation menu). Customizing this API will have no effect on the system color picker.Declaration
Objective-C
@interface PSPDFColorPickerFactory : NSObject <PSPDFOverridable>Swift
class ColorPickerFactory : NSObject, Overridable -
Declaration
Objective-C
@interface PSPDFConfigurationBuilder : PSPDFBaseConfigurationBuilderSwift
class PDFConfigurationBuilder : 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 : PSPDFModelSwift
class Compression : ModelObject -
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFDocumentSharingConfigurationBuilder : PSPDFBaseConfigurationBuilderSwift
class DocumentSharingConfigurationBuilder : BaseConfigurationBuilder -
Undocumented
Declaration
Objective-C
@interface PSPDFDocumentViewLayoutInvalidationContext : UICollectionViewLayoutInvalidationContext @endSwift
class PSPDFDocumentViewLayoutInvalidationContext : UICollectionViewLayoutInvalidationContext -
This configuration builder offers all properties of
See morePSPDFDragAndDropConfigurationin a writable version.Declaration
Objective-C
@interface PSPDFDragAndDropConfigurationBuilder : PSPDFBaseConfigurationBuilderSwift
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, FileManager -
The gallery configuration builder object offers all properties of
See morePSPDFGalleryConfigurationin a writable version, in order to build an immutablePSPDFGalleryConfigurationobject.Declaration
Objective-C
@interface PSPDFGalleryConfigurationBuilder : PSPDFBaseConfigurationBuilderSwift
class GalleryConfigurationBuilder : BaseConfigurationBuilder -
Undocumented
Declaration
Objective-C
@interface PSPDFGalleryEmbeddedBackgroundView : UIView<PSPDFOverridable> @endSwift
class GalleryEmbeddedBackgroundView : UIView, Overridable -
Undocumented
Declaration
Objective-C
@interface PSPDFGalleryFullscreenBackgroundView : UIView<PSPDFOverridable> @endSwift
class GalleryFullscreenBackgroundView : UIView, Overridable -
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 : PSPDFBaseConfigurationBuilderSwift
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 : PSPDFRenderRequestSwift
class MutableRenderRequest : RenderRequest -
A default store that saves annotations into the keychain.
Declaration
Objective-C
@interface PSPDFKeychainAnnotationSetsStore : NSObject <PSPDFAnnotationSetStore>Swift
class KeychainAnnotationSetsStore : NSObject, AnnotationSetStore -
An abstract class for a controller that manages a table view with search functionality.
See moreDeclaration
Objective-C
@interface PSPDFSearchableTableViewController : PSPDFStatefulTableViewControllerSwift
class SearchableTableViewController : StatefulTableViewController -
This configuration builder offers all properties of
See morePSPDFSignatureAppearancein a writable version.Declaration
Objective-C
@interface PSPDFSignatureAppearanceBuilder : PSPDFBaseConfigurationBuilderSwift
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 : NSObjectSwift
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
layoutSubviewsif the popover is being resized. This fixes an unexpected animation when the tableView is updated while a popover resizes.Declaration
Objective-C
@interface PSPDFNonAnimatingTableViewCell : PSPDFTableViewCellSwift
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 : UICollectionViewLayoutAttributesSwift
class ThumbnailFlowLayoutAttributes : UICollectionViewLayoutAttributes -
Subclass to enable
UIAppearancerules on the filter.Declaration
Objective-C
@interface PSPDFThumbnailFilterSegmentedControl : PSPDFSegmentedControl <PSPDFOverridable>Swift
class ThumbnailFilterSegmentedControl : SegmentedControl, 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 morePSPDFToolbarButtonfor sizing.Declaration
Objective-C
@interface PSPDFToolbarSpacerButton : PSPDFToolbarButtonSwift
class ToolbarSpacerButton : ToolbarButton -
Sends out
See morePSPDFControlEventTickevents while the button is pressed.Declaration
Objective-C
@interface PSPDFToolbarTickerButton : PSPDFToolbarButtonSwift
class ToolbarTickerButton : ToolbarButton -
A custom spacer button that visually separates button groups.
See moreDeclaration
Objective-C
@interface PSPDFToolbarSeparatorButton : PSPDFToolbarSpacerButtonSwift
class ToolbarSeparatorButton : ToolbarSpacerButton -
Undocumented
See moreDeclaration
Objective-C
@interface PSPDFToolbarSelectableButton : PSPDFToolbarButtonSwift
class ToolbarSelectableButton : ToolbarButton -
Toolbar button that shows a light gray rounded border.
Declaration
Objective-C
@interface PSPDFToolbarBorderButton : PSPDFToolbarButtonSwift
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 : PSPDFToolbarButtonSwift
class ToolbarDualButton : ToolbarButton -
Special
See morePSPDFToolbarGroupButtonused for the collapsed button item.Declaration
Objective-C
@interface PSPDFToolbarCollapsedButton : PSPDFToolbarGroupButtonSwift
class ToolbarCollapsedButton : ToolbarGroupButton -
Empty subclass for easier debugging.
Declaration
Objective-C
@interface PSPDFDocumentLabelView : PSPDFLabelView <PSPDFOverridable>Swift
class DocumentLabelView : PDFLabelView, Overridable -
Undocumented
Declaration
Objective-C
@interface PSPDFVersionDummy : NSObject @endSwift
class PSPDFVersionDummy -
The
URLDataProvidermanages automatic downloading of a file.By default, downloads will use
URLCacheto 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
targetURLis 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 attargetURLbefore 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 -
https://www.mikeash.com/pyblog/friday-qa-2017-10-27-locks-thread-safety-and-swift-2017-edition.html os_unfair_lock can be a good choice when per-lock overhead is important (because for some reason you have a huge number of them) and you don’t need fancy features. It’s implemented as a single 32-bit integer which you can place wherever you need it, so overhead is small. As the name hints, one of the features that os_unfair_lock is missing is fairness. Lock fairness means that there’s at least some attempt to ensure that different threads waiting on a lock all get a chance to acquire it. Without fairness, it’s possible for a thread that rapidly releases and re-acquires the lock to monopolize it while other threads are waiting.
See moreDeclaration
Swift
final public class UnfairLock -
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
PDFSignerclass from PSPDFKit’s Digital Signatures component.PSPDF_EXPORT(PSPDFSignatureCreationViewController)
See moreDeclaration
Swift
@available(iOS 13.0, *) @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.Example Usage: class DocumentSharingDelegateHandler: StandaloneDelegate
See more, PDFDocumentSharingViewControllerDelegate { (your delegate implementations) } // The StandaloneDelegateContainerwill 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 = handlerDeclaration
Swift
open class StandaloneDelegate<DelegateType> : NSObject where DelegateType : NSObjectProtocol