Other Enums

The following enums are available globally.

  • List of documented errors within the PSPDFAESCryptoInputStream.

    Note

    Used in the PSPDFAESCryptoInputStream -(NSError *)streamError method.
    See more

    Declaration

    Objective-C

    enum PSPDFAESCryptoInputStreamErrorCode : NSInteger {}

    Swift

    typealias AESCryptoInputStreamError.Code._ErrorType = AESCryptoInputStreamError
  • List of documented errors within the PSPDFAESCryptoOutputStream.

    Note

    Used in the PSPDFAESCryptoOutputStream -(NSError *)streamError method.
    See more

    Declaration

    Objective-C

    enum PSPDFAESCryptoOutputStreamErrorCode : NSInteger {}

    Swift

    typealias AESCryptoOutputStreamError.Code._ErrorType = AESCryptoOutputStreamError
  • The possible types of start- and end-point for line annotations.

    See more

    Declaration

    Objective-C

    enum PSPDFLineEndType : NSInteger {}

    Swift

    @frozen enum EndType : Int, @unchecked Sendable
  • Defines the type of an action that is defined in the PDF spec. See the Adobe PDF Specification for more about actions and action types.

    See more

    Declaration

    Objective-C

    enum PSPDFActionType : UInt8 {}

    Swift

    @frozen enum Kind : UInt8, @unchecked Sendable
  • PDF Annotation types.

    These options can be combined for fetching several types of annotations from a document or annotation provider. However, a single annotation must have a single type.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationType : NSUInteger {}

    Swift

    struct Kind : OptionSet, @unchecked Sendable
  • Annotation border style types.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationBorderStyle : NSUInteger {}

    Swift

    @frozen enum BorderStyle : UInt, @unchecked Sendable
  • Border effect names. See PDF Reference 1.5, 1.6. (Table 167).

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationBorderEffect : NSInteger {}

    Swift

    @frozen enum BorderEffect : Int, @unchecked Sendable
  • A set of flags specifying various characteristics of the annotation. PSPDFKit doesn’t support all of those flag settings.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationFlags : NSUInteger {}

    Swift

    struct Flag : OptionSet, @unchecked Sendable
  • Trigger events for certain viewer actions. See PDF Reference 1.7, 423ff.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationTriggerEvent : UInt8 {}

    Swift

    @frozen enum TriggerEvent : UInt8, @unchecked Sendable
  • Defines the z-index position where an annotation should be moved to.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationZIndexMove : NSInteger {}

    Swift

    @frozen enum ZIndexMove : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFVerticalAlignment) {
        PSPDFVerticalAlignmentTop = 0,
        PSPDFVerticalAlignmentCenter = 1,
        PSPDFVerticalAlignmentBottom = 2,
        PSPDFVerticalAlignmentNone = 3
    }

    Swift

    @frozen enum VerticalAlignment : UInt, @unchecked Sendable
  • Categories for the author-specific state that may be associated with an annotation.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationAuthorStateModel : NSUInteger {}
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFAnnotationPlaceholderState) {
        /// The placeholder is still dormant.
        ///
        /// Its `progress` and `error` properties are both `nil`.
        PSPDFAnnotationPlaceholderStateIdle,
    
        /// The placeholder has become active.
        ///
        /// Its `progress` property is populated with an object that can be used to display the progress of
        /// replacing the placeholder with actual content. The placeholder’s `error` property is `nil`.
        PSPDFAnnotationPlaceholderStateProgressing,
    
        /// The process of replacing the placeholder with actual content has failed.
        ///
        /// The `progress` property is `nil`. The `error` property holds an object detailing why/in which
        /// way replacing the placeholder with actual content failed.
        PSPDFAnnotationPlaceholderStateFailed,
    
        /// The process of replacing the placeholder with actual content has been cancelled.
        PSPDFAnnotationPlaceholderStateCancelled,
    
        /// The actual content has become available.
        ///
        /// The placeholder has become obsolete, so neither its `progress`, not its `error` property matter
        /// anymore.
        PSPDFAnnotationPlaceholderStateCompleted,
    }

    Swift

    @frozen enum PSPDFAnnotationPlaceholderState : Int, @unchecked Sendable
  • Possible modes for AnnotationStateManager’s stylusMode property.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationStateManagerStylusMode : NSUInteger {}

    Swift

    @frozen enum AnnotationStateManagerStylusMode : UInt, @unchecked Sendable
  • An enum representing a mode in which an annotation is transformed.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationTransformationMode : NSInteger {}

    Swift

    @frozen enum AnnotationTransformationMode : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFAppearanceMode) {
        /// Normal application appearance and page rendering, as configured by the host app.
        PSPDFAppearanceModeDefault = 0,
        /// Renders the PDF content with a sepia tone.
        PSPDFAppearanceModeSepia = 1 << 0,
        /// Inverts the PDF page content and applies color correction.
        PSPDFAppearanceModeNight = 1 << 1,
        /// All options.
        PSPDFAppearanceModeAll = PSPDFAppearanceModeDefault | PSPDFAppearanceModeSepia | PSPDFAppearanceModeNight
    }

    Swift

    struct PDFAppearanceMode : OptionSet, @unchecked Sendable
  • Indicates the type of image the bookmark indicator button should use.

    See more

    Declaration

    Objective-C

    enum PSPDFBookmarkIndicatorImageType : NSInteger {}

    Swift

    @frozen enum ImageType : Int, @unchecked Sendable
  • The sort order is currently used for bookmarks.

    See more

    Declaration

    Objective-C

    enum PSPDFBookmarkManagerSortOrder : NSUInteger {}

    Swift

    @frozen enum SortOrder : UInt, @unchecked Sendable
  • Controls if and how the idle timer should be managed.

    See more

    Declaration

    Objective-C

    enum PSPDFIdleTimerManagement : NSUInteger {}

    Swift

    @frozen enum IdleTimerManagement : UInt, @unchecked Sendable
  • Deprecated

    Deprecated in PSPDFKit 10.4 for iOS. These values are not used. Use the properties on ButtonFormField instead.

    Form field flags specific to button fields, matching bit positions in the PDF specification. These values are not used in PSPDFKit API. Use the properties on ButtonFormField instead.

    See more

    Declaration

    Objective-C

    enum PSPDFButtonFlag : NSUInteger {}

    Swift

    struct ButtonFlag : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFCacheStoragePolicy) {
        PSPDFCacheStoragePolicyAutomatic = 0,
    
        PSPDFCacheStoragePolicyAllowed,
        PSPDFCacheStoragePolicyAllowedInMemoryOnly,
        PSPDFCacheStoragePolicyNotAllowed,
    }

    Swift

    @frozen enum StoragePolicy : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFCacheStatus) {
        PSPDFCacheStatusNotCached,
        PSPDFCacheStatusInMemory,
        PSPDFCacheStatusOnDisk,
    }

    Swift

    @frozen enum Status : Int, @unchecked Sendable
  • PSPDFCacheImageSizeMatching is a bit mask that can be used to control how the cache determines if an image’s size matches a given request.

    See more

    Declaration

    Objective-C

    enum PSPDFCacheImageSizeMatching : NSUInteger {}

    Swift

    struct ImageSizeMatching : OptionSet, @unchecked Sendable
  • Deprecated

    Deprecated in PSPDFKit 10.4 for iOS. These values are not used. Use the properties on ChoiceFormField instead.

    Form field flags specific to choice fields, matching bit positions in the PDF specification. These values are not used in PSPDFKit API. Use the properties on ChoiceFormField instead.

    See more

    Declaration

    Objective-C

    enum PSPDFChoiceFlag : NSUInteger {}

    Swift

    struct ChoiceFlag : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFCollectionReusableFilterViewStyle) {
        /// Standard view.
        PSPDFCollectionReusableFilterViewStyleNone,
        /// Use a blur effect that composes well with light colors, like plain UIKit bars.
        PSPDFCollectionReusableFilterViewStyleLightBlur,
        /// Use a blur effect that is suitable for composes well with dark colors, like in the demo app.
        PSPDFCollectionReusableFilterViewStyleDarkBlur,
        /// Use a blur effect that’s tinted even lighter than the lightBlur style.
        PSPDFCollectionReusableFilterViewStyleExtraLightBlur,
    }

    Swift

    @frozen enum Style : Int, @unchecked Sendable
  • The shape of color button.

    See more

    Declaration

    Objective-C

    enum PSPDFColorButtonShape : NSInteger {}

    Swift

    enum Shape : Int, @unchecked Sendable
  • A color set describes a set of different color pickers that provide colors for a certain use case.

    Note

    The list of color sets may grow, keep this in mind when designing custom color pickers and provide a suitable default (or fall back to PSPDFKit’s built-in color picker in this case).
    See more

    Declaration

    Objective-C

    enum PSPDFColorSet : NSUInteger {}

    Swift

    @frozen enum ColorSet : UInt, @unchecked Sendable
  • Page Transition. Can be scrolling or something more fancy. See https://pspdfkit.com/guides/ios/customizing-the-interface/document-presentation-options/ for further documentation.

    See more

    Declaration

    Objective-C

    enum PSPDFPageTransition : NSUInteger {}

    Swift

    @frozen enum PageTransition : UInt, @unchecked Sendable
  • Active page mode.

    See more

    Declaration

    Objective-C

    enum PSPDFPageMode : NSUInteger {}

    Swift

    @frozen enum PageMode : UInt, @unchecked Sendable
  • Active scrolling direction. Only relevant for scrolling page transitions.

    See more

    Declaration

    Objective-C

    enum PSPDFScrollDirection : NSUInteger {}

    Swift

    @frozen enum ScrollDirection : UInt, @unchecked Sendable
  • Current active view mode.

    See more

    Declaration

    Objective-C

    enum PSPDFViewMode : NSUInteger {}

    Swift

    @frozen enum ViewMode : UInt, @unchecked Sendable
  • Default action for PDF link annotations.

    See more

    Declaration

    Objective-C

    enum PSPDFLinkAction : NSUInteger {}

    Swift

    @frozen enum LinkAction : UInt, @unchecked Sendable
  • Defines the text selection mode in TextSelectionView. Requires Features.textSelection to be enabled and textSelectionEnabled set to true.

    See more

    Declaration

    Objective-C

    enum PSPDFTextSelectionMode : NSUInteger {}

    Swift

    @frozen enum TextSelectionMode : UInt, @unchecked Sendable
  • Defines how annotations, which are drawn, are created.

    See more

    Declaration

    Objective-C

    enum PSPDFDrawCreateMode : NSUInteger {}

    Swift

    @frozen enum DrawCreateMode : UInt, @unchecked Sendable
  • Menu options when text is selected on this document.

    See more

    Declaration

    Objective-C

    enum PSPDFTextSelectionMenuAction : NSUInteger {}

    Swift

    struct TextSelectionMenuAction : OptionSet, @unchecked Sendable
  • The thumbnail bar mode controls how the PDFViewController displays thumbnails of pages when viewing a document.

    See more

    Declaration

    Objective-C

    enum PSPDFThumbnailBarMode : NSUInteger {}

    Swift

    @frozen enum ThumbnailBarMode : UInt, @unchecked Sendable
  • Defines where the scrubber but should be shown.

    See more

    Declaration

    Objective-C

    enum PSPDFScrubberBarType : NSUInteger {}

    Swift

    @frozen enum ScrubberBarType : UInt, @unchecked Sendable
  • Thumbnail grouping setting for ThumbnailBarMode.scrollable and the ThumbnailViewController.

    See more

    Declaration

    Objective-C

    enum PSPDFThumbnailGrouping : NSUInteger {}

    Swift

    @frozen enum ThumbnailGrouping : UInt, @unchecked Sendable
  • Defines when the user interface view should be shown.

    See more

    Declaration

    Objective-C

    enum PSPDFUserInterfaceViewMode : NSUInteger {}

    Swift

    @frozen enum UserInterfaceViewMode : UInt, @unchecked Sendable
  • Defines how the user interface view should animate.

    See more

    Declaration

    Objective-C

    enum PSPDFUserInterfaceViewAnimation : NSUInteger {}

    Swift

    @frozen enum UserInterfaceViewAnimation : UInt, @unchecked Sendable
  • Defines how the search is displayed.

    See more

    Declaration

    Objective-C

    enum PSPDFSearchMode : NSUInteger {}

    Swift

    @frozen enum SearchMode : UInt, @unchecked Sendable
  • Defines where the render status should be displayed.

    See more

    Declaration

    Objective-C

    enum PSPDFRenderStatusViewPosition : NSUInteger {}

    Swift

    @frozen enum RenderStatusViewPosition : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFTapAction) {
        /// Nothing happens.
        PSPDFTapActionNone,
        /// Zoom to the center of the user's tap.
        PSPDFTapActionZoom,
        /// Detect text blocks and zoom to the tapped text block.
        PSPDFTapActionSmartZoom,
    }

    Swift

    @frozen enum TapAction : UInt, @unchecked Sendable
  • Defines an adaptive value.

    See more

    Declaration

    Objective-C

    enum PSPDFAdaptiveConditional : NSUInteger {}

    Swift

    @frozen enum AdaptiveConditional : UInt, @unchecked Sendable
  • Defines how the scroll view inset should be set.

    See more

    Declaration

    Objective-C

    enum PSPDFScrollInsetAdjustment : NSUInteger {}

    Swift

    @frozen enum ScrollInsetAdjustment : UInt, @unchecked Sendable
  • Defines when the bookmark indicator should be shown on a page.

    See more

    Declaration

    Objective-C

    enum PSPDFPageBookmarkIndicatorMode : NSUInteger {}

    Swift

    @frozen enum PageBookmarkIndicatorMode : UInt, @unchecked Sendable
  • Defines the sound player style used for playing back sound annotations.

    See more

    Declaration

    Objective-C

    enum PSPDFSoundAnnotationPlayerStyle : NSUInteger {}

    Swift

    @frozen enum SoundAnnotationPlayerStyle : UInt, @unchecked Sendable
  • Possible options for whether signature annotations should be saved.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureSavingStrategy : NSUInteger {}

    Swift

    @frozen enum SignatureSavingStrategy : UInt, @unchecked Sendable
  • Defines if certificate management/selection should be allowed for digitally signing a document.

    This is only used if your license contains the Digital Signatures component and was originally purchased before the introduction of the Electronic Signatures component in March 2021. If you originally purchased after this date, Digital Signatures does not provide any UI for adding signatures. The Electronic Signatures component does not support selecting certificates.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureCertificateSelectionMode : NSUInteger {}

    Swift

    @frozen enum SignatureCertificateSelectionMode : UInt, @unchecked Sendable
  • Controls whether spreads can grow larger than the actual view. This can be helpful on smaller screens to make the content more readable.

    See more

    Declaration

    Objective-C

    enum PSPDFConfigurationSpreadFitting : NSInteger {}

    Swift

    @frozen enum SpreadFitting : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFMarkupAnnotationMergeBehavior) {
        /// Never merge markup annotations.
        PSPDFMarkupAnnotationMergeNever = 0,
    
        /// Attempt to merge markup annotations if the color matches.
        PSPDFMarkupAnnotationMergeIfColorMatches,
    }

    Swift

    @frozen enum MarkupAnnotationMergeBehavior : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFContextMenuOption) {
        /// Displays a context menu. Suppresses situations where a popover would fit better.
        PSPDFContextMenuOptionMenuOnly,
        /// Displays a context menu. Allows a popover if situation fits.
        PSPDFContextMenuOptionAllowPopovers,
        /// Does not allow context menu, only presents popovers (if possible, otherwise does not present anything)
        PSPDFContextMenuOptionPopoversOnly,
    }

    Swift

    @frozen enum ContextMenuOption : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ERROR_ENUM(PSPDFCryptorErrorDomain, PSPDFCryptorErrorCode) {
        PSPDFCryptorErrorFailedToInitCryptor = 100,
        PSPDFCryptorErrorFailedToProcessFile = 110,
        PSPDFCryptorErrorInvalidIV = 200,
        PSPDFCryptorErrorWritingOutputFile = 600,
        PSPDFCryptorErrorReadingInputFile = 700,
    }

    Swift

    typealias CryptorError.Code._ErrorType = CryptorError
  • Specifies which types of operations the data provider supports. Every data provider must support reading.

    See more

    Declaration

    Objective-C

    enum PSPDFDataProvidingAdditionalOperations : NSUInteger {}

    Swift

    struct DataProvidingAdditionalOperations : OptionSet, @unchecked Sendable
  • Specifies the type of PSPDFDataSink you’re requesting.

    See more

    Declaration

    Objective-C

    enum PSPDFDataSinkOptions : NSUInteger {}

    Swift

    struct DataSinkOptions : OptionSet, @unchecked Sendable
  • The different transform methods (see Section 8.7.1, “Transform Methods”). DocMDP — Used to detect modifications to a document relative to a signature field that is signed by the originator of a document; see “DocMDP” on page 731. UR — Used to detect modifications to a document that would invalidate a signature in a rights-enabled document; see “UR” on page 733. FieldMDP — Used to detect modifications to a list of form fields specified in TransformParams; see “FieldMDP” on page 736. Identity — Used when signing a single object, which is specified by the value of Data in the signature reference dictionary (see Table 8.103). This transform method supports signing of FDF files. See “Identity” on page 737 for details.

    See more

    Declaration

    Objective-C

    enum PSPDFDigitalSignatureReferenceTransformMethod : NSUInteger {}

    Swift

    @frozen enum TransformMethod : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFDiskCacheFileFormat) {
        /// JPEG encoding.
        PSPDFDiskCacheFileFormatJPEG,
        /// PNG encoding.
        PSPDFDiskCacheFileFormatPNG,
    }

    Swift

    @frozen enum FileFormat : Int, @unchecked Sendable
  • Document saving strategy.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentSaveStrategy : NSInteger {}

    Swift

    @frozen enum SaveStrategy : Int, @unchecked Sendable
  • Returns if JavaScript code can execute on this document.

    See more

    Declaration

    Objective-C

    enum PSPDFJavaScriptStatus : NSInteger {}

    Swift

    @frozen enum JavaScriptStatus : Int, @unchecked Sendable
  • Annotations can be saved in the PDF or alongside in an external file.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationSaveMode : NSInteger {}

    Swift

    @frozen enum AnnotationSaveMode : Int, @unchecked Sendable
  • Creates annotations based on the text content. See annotationsByDetectingLinkTypes:forPagesAtIndexes:options:progress:error:.

    See more

    Declaration

    Objective-C

    enum PSPDFTextCheckingType : NSUInteger {}

    Swift

    struct TextCheckingType : OptionSet, @unchecked Sendable
  • The strategy used by the PSPDFDocumentCheckpointer to save checkpoints.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentCheckpointingStrategy : NSUInteger {}

    Swift

    @frozen enum DocumentCheckpointingStrategy : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFDocumentOrientation) {
        PSPDFDocumentOrientationPortrait,
        PSPDFDocumentOrientationLandscape,
    }

    Swift

    @frozen enum PDFDocumentOrientation : Int, @unchecked Sendable
  • The interactive capabilities of the document editor.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentEditorInteractiveCapabilities : NSUInteger {}

    Swift

    struct InteractiveCapabilities : OptionSet, @unchecked Sendable
  • A set of flags specifying which operations shall be permitted when the document is opened with user access.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentPermissions : NSUInteger {}

    Swift

    struct DocumentPermissions : OptionSet, @unchecked Sendable
  • An enumeration that specifies document permissions level.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentPermissionsLevel : NSUInteger {}

    Swift

    @frozen enum DocumentPermissionsLevel : UInt, @unchecked Sendable
  • The algorithm to use to encrypt a document.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentEncryptionAlgorithm : NSUInteger {}

    Swift

    @frozen enum DocumentEncryptionAlgorithm : UInt, @unchecked Sendable
  • The possible file formats that can be used for sharing documents.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentSharingFileFormatOptions : NSUInteger {}

    Swift

    struct FileFormatOptions : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFDocumentSharingPagesOptions) {
        /// Only the page set in `pageIndex` of `PDFViewController`.
        PSPDFDocumentSharingPagesOptionCurrent = 1 << 0,
    
        /// Let the user select a range of pages to share.
        PSPDFDocumentSharingPagesOptionRange = 1 << 1,
    
        /// Send the whole document.
        PSPDFDocumentSharingPagesOptionAll = 1 << 2,
    
        /// Share all pages that contain annotations.
        PSPDFDocumentSharingPagesOptionAnnotated = 1 << 3
    }

    Swift

    struct PageOptions : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFDocumentSharingAnnotationOptions) {
        /// Save annotations in the PDF.
        ///
        /// Embed annotations into the PDF.
        ///
        /// @warning When using this option for printing, no annotations may be printed. This is a result of internal limitations of the printing system on iOS.
        /// @see [3rd-Party Compatibility](https://pspdfkit.com/guides/ios/miscellaneous/3rd-party-compatibility/)
        PSPDFDocumentSharingAnnotationOptionEmbed = 1 << 0,
    
        /// Render annotations into the PDF.
        PSPDFDocumentSharingAnnotationOptionFlatten = 1 << 1,
    
        /// Similar to `PSPDFDocumentSharingAnnotationOptionFlatten`, but renders annotations
        /// into the PDF with applied visibility settings for printing and converts notes to printable text.
        ///
        /// @note Use this option to ensure `PSPDFAnnotationFlagPrint` is correctly applied. If annotations
        /// are passed to the iOS printing service without previous flattening, visibility flags might not be
        /// honored correctly and annotations might appear different than in PSPDFKit.
        PSPDFDocumentSharingAnnotationOptionFlattenForPrint = 1 << 2,
    
        /// Save annotations + add summary. Not available on macOS.
        PSPDFDocumentSharingAnnotationOptionSummary = 1 << 3,
    
        /// Remove all annotations.
        PSPDFDocumentSharingAnnotationOptionRemove = 1 << 4
    }

    Swift

    struct AnnotationOptions : OptionSet, @unchecked Sendable
  • Defines a moment in the sharing process.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentSharingStep : NSUInteger {}

    Swift

    @frozen enum Step : UInt, @unchecked Sendable
  • The spread mode determines the conversion between spreads and pages.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentViewLayoutSpreadMode : NSInteger {}
  • The page mode determines how a page is displayed relative to its neighboring pages.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentViewLayoutPageMode : NSInteger {}
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFDownloadManagerObjectState) {
        PSPDFDownloadManagerObjectStateNotHandled,
        PSPDFDownloadManagerObjectStateWaiting,
        PSPDFDownloadManagerObjectStateLoading,
        PSPDFDownloadManagerObjectStateFailed,
    }

    Swift

    @frozen enum ObjectState : UInt, @unchecked Sendable
  • Defines the types of items that are dragged.

    See more

    Declaration

    Objective-C

    enum PSPDFDragType : NSUInteger {}

    Swift

    struct DragType : OptionSet, @unchecked Sendable
  • Defines the types of items that are dropped.

    See more

    Declaration

    Objective-C

    enum PSPDFDropType : NSUInteger {}

    Swift

    struct DropType : OptionSet, @unchecked Sendable
  • Defines targets where drops can happen.

    See more

    Declaration

    Objective-C

    enum PSPDFDropTarget : NSUInteger {}

    Swift

    struct DropTarget : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFDrawViewInputMode) {
        /// Touches perform drawing operations.
        PSPDFDrawViewInputModeDraw,
    
        /// Touches perform erase operations.
        PSPDFDrawViewInputModeErase
    }

    Swift

    @frozen enum InputMode : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFEditingOperation) {
        /// One page was removed. `affectedPageIndex` specifies which index.
        PSPDFEditingOperationRemove,
        /// The page at `affectedPageIndex` was moved to `pageIndexDestination`.
        PSPDFEditingOperationMove,
        /// One page was inserted at `affectedPageIndex`.
        PSPDFEditingOperationInsert,
        /// The page at `affectedPageIndex` was rotated.
        PSPDFEditingOperationRotate,
        /// One page reference was inserted at `affectedPageIndex`.
        PSPDFEditingOperationInsertReference
    }

    Swift

    @frozen enum Operation : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFEmbeddedGoToActionTarget) {
        /// Not yet supported
        PSPDFEmbeddedGoToActionTargetParentOfCurrentDocument,
        PSPDFEmbeddedGoToActionTargetChildOfCurrentDocument,
    }

    Swift

    @frozen enum Target : UInt, @unchecked Sendable
  • List of documented errors within the PSPDFErrorDomain.

    Note

    Various PSPDFKit methods can also return errors from Apple error domains.
    See more

    Declaration

    Objective-C

    enum PSPDFErrorCode : NSInteger {}

    Swift

    typealias PSPDFKitError.Code._ErrorType = PSPDFKitError
  • An enum representing the direction of fast scroll.

    See more

    Declaration

    Objective-C

    enum PSPDFFastScrollDirection : NSInteger {}

    Swift

    @frozen enum FastScrollDirection : Int, @unchecked Sendable
  • The types of conflicts that PSPDFKit can detect.

    See more

    Declaration

    Objective-C

    enum PSPDFFileConflictType : NSUInteger {}

    Swift

    enum FileConflictType : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFFlexibleToolbarPosition) {
        /// Undefined position. Upon display the toolbar can select an appropriate default
        /// position or restore position from previous runs.
        PSPDFFlexibleToolbarPositionNone = 0,
        /// The toolbar replaces the top (navigation)bar.
        PSPDFFlexibleToolbarPositionInTopBar = 1 << 0,
        /// The toolbar is positioned on the left side of the available screen real estate.
        PSPDFFlexibleToolbarPositionLeft = 1 << 1,
        /// The toolbar is positioned on the right side of the available screen real estate.
        PSPDFFlexibleToolbarPositionRight = 1 << 2,
        /// The toolbar is positioned at the top, below the navigation bar.
        PSPDFFlexibleToolbarPositionTop = 1 << 3,
        /// The toolbar is positioned on the left or right side of the available screen real estate.
        PSPDFFlexibleToolbarPositionHorizontal = PSPDFFlexibleToolbarPositionInTopBar | PSPDFFlexibleToolbarPositionTop,
        /// The toolbar is positioned in the top (navigation)bar or below it.
        PSPDFFlexibleToolbarPositionVertical = PSPDFFlexibleToolbarPositionLeft | PSPDFFlexibleToolbarPositionRight,
        /// The default toolbar positions in the top (navigation)bar and on the left and right side of the available screen real estate.
        PSPDFFlexibleToolbarPositionDefault = PSPDFFlexibleToolbarPositionInTopBar | PSPDFFlexibleToolbarPositionVertical,
        /// All valid toolbar positions. Excluding `PSPDFFlexibleToolbarPositionNone`.
        PSPDFFlexibleToolbarPositionAll = PSPDFFlexibleToolbarPositionHorizontal | PSPDFFlexibleToolbarPositionVertical,
    }

    Swift

    struct Position : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFToolbarGroupButtonIndicatorPosition) {
        /// The toolbar button groping indicator will not not be shown.
        PSPDFToolbarGroupButtonIndicatorPositionNone = 0,
        /// The toolbar button groping indicator will be positioned on the bottom left side of the button.
        PSPDFToolbarGroupButtonIndicatorPositionBottomLeft,
        /// The toolbar button groping indicator will be positioned on the bottom right side of the button.
        PSPDFToolbarGroupButtonIndicatorPositionBottomRight,
    }
  • Defines all the available types a form field can be.

    See more

    Declaration

    Objective-C

    enum PSPDFFormFieldType : NSUInteger {}

    Swift

    @frozen enum Kind : UInt, @unchecked Sendable
  • The possible formats a form submission can be encoded in.

    See more

    Declaration

    Objective-C

    enum PSPDFSubmitFormActionFormat : NSUInteger {}

    Swift

    @frozen enum SubmitFormActionFormat : UInt, @unchecked Sendable
  • The free text annotation intent type. (Optional; PDF 1.6)

    See more

    Declaration

    Objective-C

    enum PSPDFFreeTextAnnotationIntent : NSInteger {}

    Swift

    @frozen enum Intent : Int, @unchecked Sendable
  • PSPDFGalleryContainerViewContentState controls which content view will be visible.

    See more

    Declaration

    Objective-C

    enum PSPDFGalleryContainerViewContentState : NSUInteger {}

    Swift

    @frozen enum ContentState : UInt, @unchecked Sendable
  • PSPDFGalleryContainerViewPresentationMode controls which background view will be visible.

    See more

    Declaration

    Objective-C

    enum PSPDFGalleryContainerViewPresentationMode : NSUInteger {}

    Swift

    @frozen enum PresentationMode : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFGalleryItemContentState) {
        /// The item is waiting to load its content.
        PSPDFGalleryItemContentStateWaiting,
    
        /// The item is currently loading its content.
        PSPDFGalleryItemContentStateLoading,
    
        /// The item's content is ready.
        PSPDFGalleryItemContentStateReady,
    
        /// The item has encountered an error while loading its content.
        PSPDFGalleryItemContentStateError
    }

    Swift

    @frozen enum ContentState : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFGalleryManifestErrorCode) {
        PSPDFGalleryManifestErrorCodeNoDataSourceProvided
    }

    Swift

    @frozen enum PSPDFGalleryManifestErrorCode : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFGalleryVideoItemQuality) {
        PSPDFGalleryVideoItemQualityUnknown,
        PSPDFGalleryVideoItemQuality240p,
        PSPDFGalleryVideoItemQuality360p,
        PSPDFGalleryVideoItemQuality720p,
        PSPDFGalleryVideoItemQuality1080p,
    }

    Swift

    @frozen enum Quality : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFGalleryVideoItemCoverMode) {
        /// The cover is not visible. Correspondents to `none`.
        PSPDFGalleryVideoItemCoverModeNone,
    
        /// The cover is visible and a video preview is displayed. Correspondents to `preview`.
        PSPDFGalleryVideoItemCoverModePreview,
    
        /// The cover is visible and an image is displayed. Correspondents to `image`.
        PSPDFGalleryVideoItemCoverModeImage,
    
        /// The cover is visible and the underlying PDF shines through. Correspondents to `clear`.
        PSPDFGalleryVideoItemCoverModeClear
    }

    Swift

    @frozen enum CoverMode : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFGalleryViewControllerState) {
        /// The view controller is currently not doing anything.
        PSPDFGalleryViewControllerStateIdle,
    
        /// The manifest file is currently downloaded.
        PSPDFGalleryViewControllerStateLoading,
    
        /// The manifest file has been downloaded and the view controller is ready.
        PSPDFGalleryViewControllerStateReady,
    
        /// The view controller could not load or parse the manifest file.
        PSPDFGalleryViewControllerStateError
    }

    Swift

    @frozen enum State : UInt, @unchecked Sendable
  • Specifies how a PSPDFImageDocument should save its contents.

    See more

    Declaration

    Objective-C

    enum PSPDFImageSaveMode : NSInteger {}

    Swift

    @frozen enum SaveMode : Int, @unchecked Sendable
  • Used to customize the image quality options offered for adding images.

    See more

    Declaration

    Objective-C

    enum PSPDFImageQuality : NSUInteger {}

    Swift

    struct ImageQuality : OptionSet, @unchecked Sendable
  • Bitmask for diagnostics of a cache entry.

    See more

    Declaration

    Objective-C

    enum PSPDFInstantCacheEntryState : NSUInteger {}

    Swift

    struct InstantCacheEntryState : OptionSet, @unchecked Sendable
  • Lists the observable states of an Instant document descriptor and its sync cycle.

    The term “sync cycle” refers to the repetitive transitions between the states “receiving changes” and “sending changes” until there are no unsynced local changes remaining, and the document becomes “clean”. If you are using automatic sync, a sync cycle will begin PSPDFInstantDocumentDescriptor.delayForSyncingLocalChanges seconds after the last change to an annotation in the document. When listening for server changes, a sync cycle can additionally be triggered by changes coming in from the server even before that interval has elapsed.
    When not listening for server changes and with automatic sync of local changes disabled, a sync cycle starts whenever you call -[PSPDFInstantDocumentDescriptor sync].

    PSPDFInstantDidFinishSyncingNotification is posted whenever a sync cycle completes successfully. If the cycle fails, PSPDFInstantDidFailSyncingNotification is posted instead.

    Note

    The states gathered and exposed in this enum have been preselected for relevance to an end user. If you find that you cannot provide the kind of feedback you need to the users of your app, please contact us via https://pspdfkit.com/support/request/
    See more

    Declaration

    Objective-C

    enum PSPDFInstantDocumentState : NSInteger {}

    Swift

    @frozen enum InstantDocumentState : Int, @unchecked Sendable
  • Possible error codes in the PSPDFInstantErrorDomain.

    See more

    Declaration

    Objective-C

    enum PSPDFInstantErrorCode : NSInteger {}

    Swift

    typealias InstantError.Code._ErrorType = InstantError
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFLabelStyle) {
        /// Single color.
        PSPDFLabelStyleFlat,
        /// Uses blur.
        PSPDFLabelStyleModern
    }

    Swift

    @frozen enum Style : UInt, @unchecked Sendable
  • Represents the status of a document in the library.

    See more

    Declaration

    Objective-C

    enum PSPDFLibraryIndexStatus : NSUInteger {}

    Swift

    @frozen enum IndexStatus : UInt, @unchecked Sendable
  • Specifies the version of FTS the PSPDFLibrary should use.

    See more

    Declaration

    Objective-C

    enum PSPDFLibraryFTSVersion : NSUInteger {}

    Swift

    @frozen enum FTSVersion : UInt, @unchecked Sendable
  • Specifies the priority indexing takes in task scheduling.

    See more

    Declaration

    Objective-C

    enum PSPDFLibraryIndexingPriority : NSUInteger {}

    Swift

    @frozen enum IndexingPriority : UInt, @unchecked Sendable
  • Specifies what data is to be indexed to Spotlight.

    See more

    Declaration

    Objective-C

    enum PSPDFLibrarySpotlightIndexingType : NSInteger {}

    Swift

    @frozen enum SpotlightIndexingType : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(UInt8, PSPDFLinkAnnotationType) {
        PSPDFLinkAnnotationPage = 0,
        PSPDFLinkAnnotationWebURL,
        PSPDFLinkAnnotationDocument,
        PSPDFLinkAnnotationVideo,
        /// This is a placeholder for both YouTube and Vimeo
        PSPDFLinkAnnotationYouTube,
        PSPDFLinkAnnotationAudio,
        PSPDFLinkAnnotationImage,
        PSPDFLinkAnnotationBrowser,
        /// Any annotation format that is not recognized is custom. (e.g. tel://)
        PSPDFLinkAnnotationCustom,
    }

    Swift

    @frozen enum Kind : UInt8, @unchecked Sendable
  • To fetch log messages, you can use either:

    • Xcode’s console
    • Apple’s Console.app
    • or the ‘log’ terminal utility.

    PSPDFKit uses os_log under the hood to send log messages and categories to the OS. An additional filter is used for performance reasons, as os_log is wrapped to support external log handlers, and therefore logging has an impact on performance.

    The Debug and Info log levels have to be enabled separately in the Console app’s in Action menu.

    Terminal: Debug requires separate activation to work streamed. log stream –level debug –predicate ‘subsystem == “com.pspdfkit.sdk”’ –style compact To enable all levels: sudo log config –mode “level:debug” –subsystem com.pspdfkit.sdk See also: https://www.iosdev.recipes/simulator/os_log/

    When using Simulator, prefix Terminal log with xcrun simctrl: xcrun simctl spawn booted log stream –level debug –style syslog –color none –predicate ‘subsystem contains “com.pspdfkit.sdk”’

    If the suggestion above doesn’t work (e.g. “Error from getpwuid_r: 0 (Undefined error: 0)”), we recommend using Console.app for reading log messages.

    On iOS, debug messages are re-classified from DEBUG to INFO level, in order to work around FB9028830 (os_log Debug streaming does not work on iOS Simulator). This bug does not impact Mac Catalyst, so no reclassification is necessary there. See also: https://stackoverflow.com/questions/57509909/swift-oslog-os-log-not-showing-up-in-console-app

    See more

    Declaration

    Objective-C

    enum PSPDFLogLevelMask : NSUInteger {}

    Swift

    struct LogLevelMask : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFMediaPlayerControlStyle) {
        /// Shows no controls whatsoever.
        PSPDFMediaPlayerControlStyleNone,
    
        /// Shows the default control set.
        PSPDFMediaPlayerControlStyleDefault
    }

    Swift

    @frozen enum ControlStyle : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFMediaPlayerControllerContentState) {
        /// The player has no idea what the content state is and hasn't started.
        PSPDFMediaPlayerControllerContentStateIdle,
    
        /// The player is currently loading information about the content.
        PSPDFMediaPlayerControllerContentStateLoading,
    
        /// The player has found that the content is playable.
        PSPDFMediaPlayerControllerContentStateReady,
    
        /// The player has encountered an error. This might be because the Internet
        /// connection is unavailable to fetch a remote item or because the item is
        /// unsupported. You can query `contentError` to find out what exactly went wrong.
        PSPDFMediaPlayerControllerContentStateError
    }

    Swift

    @frozen enum ContentState : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFMediaPlayerCoverMode) {
        /// Shows a preview of the video as the cover.
        PSPDFMediaPlayerCoverModePreview,
    
        /// Shows a custom image as the cover.
        PSPDFMediaPlayerCoverModeCustom,
    
        /// Hides the cover completely.
        ///
        /// @note If you chose this cover mode, the underlaying player instance will be initialized even
        /// if the content is not playing yet.
        PSPDFMediaPlayerCoverModeHidden,
    
        /// Shows the cover and hides the video view while the cover is visible.
        PSPDFMediaPlayerCoverModeClear
    }

    Swift

    @frozen enum CoverMode : UInt, @unchecked Sendable
  • Defines how a PSPDFModel property key should be encoded into an archive.

    See more

    Declaration

    Objective-C

    enum PSPDFModelEncodingBehavior : NSUInteger {}

    Swift

    @frozen enum EncodingBehavior : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFNamedActionType) {
        /// No named action.
        PSPDFNamedActionTypeNone,
        /// Go to the next page in the document.
        PSPDFNamedActionTypeNextPage,
        /// Go to the previous page in the document
        PSPDFNamedActionTypePreviousPage,
        /// Go to the first page in the document.
        PSPDFNamedActionTypeFirstPage,
        /// Go to the last page in the document.
        PSPDFNamedActionTypeLastPage,
        /// Go back using `BackForwardActionList`. Only possible after executing another navigation action.
        PSPDFNamedActionTypeGoBack,
        /// Go forward using `BackForwardActionList`. Only possible after executing a GoBack action.
        PSPDFNamedActionTypeGoForward,
        PSPDFNamedActionTypeGoToPage,
        PSPDFNamedActionTypeFind,
        /// Shows the UI to configure and start printing the document.
        PSPDFNamedActionTypePrint,
        /// Shows `OutlineViewController` for the document.
        PSPDFNamedActionTypeOutline,
        PSPDFNamedActionTypeSearch,
        PSPDFNamedActionTypeBrightness,
        /// Not implemented.
        PSPDFNamedActionTypeZoomIn,
        /// Not implemented.
        PSPDFNamedActionTypeZoomOut,
        /// Triggers `Document.save()`.
        PSPDFNamedActionTypeSaveAs,
        PSPDFNamedActionTypeInfo,
        PSPDFNamedActionTypeUnknown = NSUIntegerMax,
    }

    Swift

    @frozen enum NamedActionType : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFPageTriggerEvent) {
        /// O (0) Action to be performed when the page is opened.
        PSPDFPageTriggerEventOpen,
        /// C (1) Action to be performed when the page is closed.
        PSPDFPageTriggerEventClose
    }

    Swift

    @frozen enum TriggerEvent : UInt, @unchecked Sendable
  • The type of new page that will be added

    See more

    Declaration

    Objective-C

    enum PSPDFNewPageType : NSInteger {}

    Swift

    @frozen enum NewPageType : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFPolygonAnnotationIntent) {
        /// No intent.
        PSPDFPolygonAnnotationIntentNone = 0,
    
        /// The annotation is intended to function as a cloud object.
        PSPDFPolygonAnnotationIntentPolygonCloud,
    
        /// The polygon annotation is intended to function as a dimension. (not implemented)
        PSPDFPolygonAnnotationIntentPolygonDimension
    }

    Swift

    @frozen enum Intent : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFPresentationStyle) {
        /// Present the view controller using the style in its `modalPresentationStyle`.
        PSPDFPresentationStyleNone,
    
        /// Present the view controller full-width anchored to the bottom of the screen if the width is horizontally compact, and as a popover otherwise.
        PSPDFPresentationStyleHalfModal,
    }

    Swift

    @frozen enum PresentationStyle : UInt, @unchecked Sendable
  • The user interface style for the contents when presenting in a half-modal or a popover.

    See more

    Declaration

    Objective-C

    enum PSPDFPresentationHalfModalStyle : NSUInteger {}

    Swift

    @frozen enum PresentationHalfModalStyle : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFPrintMode) {
        /// The interactive mode presents the `UIPrintInteractionController`.
        PSPDFPrintModeInteractive,
    
        /// This mode will not show a document preview or any other options (such as print count).
        PSPDFPrintModeChoosePrinterOnly,
    
        /// This mode will use the set `UIPrinter` object on `defaultPrinter` to invoke printing without further UI.
        PSPDFPrintModePrintDirect
    }

    Swift

    @frozen enum Mode : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, PSPDFPrivateKeyEncoding) {
        /// A PKCS#8 encoded private key.
        PSPDFPrivateKeyEncodingPKCS8,
        /// A PKCS#1 encoded private key. Both PEM and raw ASN.1 binary format supported.
        PSPDFPrivateKeyEncodingPKCS1,
    }

    Swift

    enum Encoding : Int, @unchecked Sendable
  • Specifies how a annotation should be included in the resulting document. See modifyAnnotationsOfType:change: and modifyAnnotations:change:error:.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationChange : NSInteger {}

    Swift

    @frozen enum AnnotationChange : Int, @unchecked Sendable
  • Specifies if the item (image) should be located in the foreground or background

    See more

    Declaration

    Objective-C

    enum PSPDFItemZPosition : NSInteger {}
  • Supported language to use when performing OCR.

    See more

    Declaration

    Objective-C

    enum PSPDFOCRLanguage : NSInteger {}

    Swift

    enum OCRLanguage : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFReachability) {
        PSPDFReachabilityUnknown,
        PSPDFReachabilityUnreachable,
        PSPDFReachabilityWiFi,
        /// iOS only
        PSPDFReachabilityWWAN,
    }

    Swift

    @frozen enum ReachabilityStatus : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFRenderType) {
        /// Renders a single page.
        PSPDFRenderTypePage,
    
        /// Exports or transforms a document
        PSPDFRenderTypeProcessor,
    
        /// Useful to apply settings to all render types.
        PSPDFRenderTypeAll = NSUIntegerMax
    }

    Swift

    @frozen enum RenderType : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFRenderFilter) {
        /// If set, a grayscale filter will be applied.
        PSPDFRenderFilterGrayscale = 1 << 0,
    
        /// If set and `invertRenderColor` is `true`, the inverted mode (a.k.a. night mode) will be rendered color correct.
        PSPDFRenderFilterColorCorrectInverted = 1 << 1,
    
        /// If set, a sepia filter will be applied.
        PSPDFRenderFilterSepia = 1 << 2
    }

    Swift

    struct RenderFilter : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFRenderQueuePriority) {
        /// Used for unspecified renderings with the lowest priority.
        PSPDFRenderQueuePriorityUnspecified = 0,
    
        /// Used for renderings that the user is not aware of, such as building a cache in the background.
        PSPDFRenderQueuePriorityBackground = 100,
    
        /// Used for renderings that the user might see but that are not necessary to complete, such as generating thumbnails that are not necessary for the user to properly work with a document but.
        PSPDFRenderQueuePriorityUtility = 200,
    
        /// Used for renderings that the user requested but that are not required for the user to keep using a document.
        PSPDFRenderQueuePriorityUserInitiated = 300,
    
        /// Used for renderings that the user requested and that are currently blocking their workflow.
        PSPDFRenderQueuePriorityUserInteractive = 400,
    }

    Swift

    @frozen enum Priority : UInt, @unchecked Sendable
  • The render request cache policy controls if and how the request, once scheduled, access the cache.

    See more

    Declaration

    Objective-C

    enum PSPDFRenderRequestCachePolicy : NSInteger {}

    Swift

    @frozen enum CachePolicy : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFRenditionActionType) {
        PSPDFRenditionActionTypeUnknown = -1,
        PSPDFRenditionActionTypePlayStop,
        PSPDFRenditionActionTypeStop,
        PSPDFRenditionActionTypePause,
        PSPDFRenditionActionTypeResume,
        PSPDFRenditionActionTypePlay,
    }

    Swift

    @frozen enum Kind : Int, @unchecked Sendable
  • Flags for reset-form actions, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFResetFormActionFlag : NSUInteger {}

    Swift

    struct Flag : OptionSet, @unchecked Sendable
  • The set of predefined knobs to resize the annotation.

    See more

    Declaration

    Objective-C

    enum PSPDFResizableViewOuterKnob : NSUInteger {}

    Swift

    @frozen enum OuterKnob : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFKnobType) {
        /// Used to resize the annotation.
        PSPDFKnobTypeOuter,
        /// Used to adjust the `points` of supported annotations, such as the start and end points of a `PSPDFLineAnnotation`.
        PSPDFKnobTypeInner,
        /// Used to rotate the annotation.
        PSPDFKnobTypeRotation,
    }

    Swift

    @frozen enum KnobType : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFResizableViewMode) {
        /// Nothing is currently happening.
        PSPDFResizableViewModeIdle,
        /// The annotation is being moved.
        PSPDFResizableViewModeMove,
        /// The annotation is being resized.
        PSPDFResizableViewModeResize,
        /// The shape of the annotation is being adjusted (e.g. polyline shape)
        PSPDFResizableViewModeAdjust,
        /// The annotation is being rotated.
        PSPDFResizableViewModeRotate,
    }

    Swift

    @frozen enum Mode : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFMediaScreenWindowType) {
        PSPDFMediaScreenWindowTypeFloating,
        PSPDFMediaScreenWindowTypeFullscreen,
        PSPDFMediaScreenWindowTypeHidden,
        /// Default value
        PSPDFMediaScreenWindowTypeUseAnnotationRectangle,
    }

    Swift

    @frozen enum MediaScreenWindowType : UInt, @unchecked Sendable
  • The content scale describes how each spread lays out its content.

    See more

    Declaration

    Objective-C

    enum PSPDFScrollPerSpreadLayoutContentScale : NSInteger {}

    Swift

    @frozen enum ContentScale : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFSearchStatus) {
        /// Search hasn't started yet.
        PSPDFSearchStatusIdle,
        /// Search operation is running.
        PSPDFSearchStatusActive,
        /// Search has been finished.
        PSPDFSearchStatusFinished,
        /// Search finished but there wasn't any content to search.
        PSPDFSearchStatusFinishedNoText,
        /// Search has been cancelled.
        PSPDFSearchStatusCancelled
    }

    Swift

    @frozen enum Status : Int, @unchecked Sendable
  • Visibility options for positioning the search bar.

    See more

    Declaration

    Objective-C

    enum PSPDFSearchBarPinning : NSUInteger {}

    Swift

    @frozen enum SearchBarPinning : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFSearchResultScope) {
        /// The search results shown with this scope are all from a given page range.
        PSPDFSearchResultScopePageRange,
        /// The search results shown with this scope are from the whole document.
        PSPDFSearchResultScopeDocument,
    }

    Swift

    @frozen enum ResultScope : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFSelectableCollectionViewCellStyle) {
        PSPDFSelectableCollectionViewCellStyleNone,
        PSPDFSelectableCollectionViewCellStyleCheckmark,
        PSPDFSelectableCollectionViewCellStyleBorder,
        PSPDFSelectableCollectionViewCellStyleDimmedBackgroundWithCheckmark,
    }

    Swift

    @frozen enum SelectableCollectionViewCellStyle : UInt, @unchecked Sendable
  • The possible UX settings that can be set by a PDFSettingsViewController.

    See more

    Declaration

    Objective-C

    enum PSPDFSettingsOptions : NSUInteger {}

    Swift

    struct Options : OptionSet, @unchecked Sendable
  • Configures the style of a digital signature.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureAppearanceMode : NSUInteger {}

    Swift

    @frozen enum Mode : UInt, @unchecked Sendable
  • The different kinds of input methods we support for creating a handwritten signature.

    See more

    Declaration

    Objective-C

    enum PSPDFDrawInputMethod : NSUInteger {}

    Swift

    @frozen enum DrawInputMethod : UInt, @unchecked Sendable
  • Defines the possible biometric properties to store in a digital signature.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureBiometricPropertiesOption : NSUInteger {}

    Swift

    struct Option : OptionSet, @unchecked Sendable
  • The supported encryption algorithms that can be used when signing a document.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureEncryptionAlgorithm : NSUInteger {}

    Swift

    @frozen enum PDFSignatureEncryptionAlgorithm : UInt, @unchecked Sendable
  • A hash algorithm or hash function is a function that maps data of arbitrary size to data of a fixed size. In the context of PDF, this arbitrary data may represent a part of a document. The output of a hash function is always identical if the input data is the same. This fact can be used to check if a document has been altered intentionally or accidentally.

    PSPDFKit supports several hash functions. This list is not a complete list of every hash algorithm that is available. Some hash algorithms are not supported yet by the PDF specification for their use in digital signatures.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureHashAlgorithm : NSUInteger {}

    Swift

    @frozen enum PDFSignatureHashAlgorithm : UInt, @unchecked Sendable
  • Severity of a signature validation problem

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureStatusSeverity : NSInteger {}

    Swift

    @frozen enum Severity : Int, @unchecked Sendable
  • Integrity status of a signature field.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureIntegrityStatus : NSInteger {}

    Swift

    @frozen enum Integrity : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ERROR_ENUM(PSPDFSignerErrorDomain, PSPDFSignerErrorCode) {
        /// No error during the signing process.
        PSPDFSignerErrorNone = noErr,
        /// A signature form element was not found in the document.
        PSPDFSignerErrorNoFormElementSet = 0x1,
        /// An error occurred while generating the PKCS#7 structure.
        PSPDFSignerErrorCannotNotCreatePKCS7 = 0x100,
        /// A problem occurred while adding the signature to the PKCS#7.
        PSPDFSignerErrorCannotNotAddSignatureToPKCS7 = 0x101,
        /// A problem occurred while initializing the PKCS#7 structure.
        PSPDFSignerErrorCannotNotInitPKCS7 = 0x102,
        /// An error occurred while generating the PKCS#7 signature.
        PSPDFSignerErrorCannotGeneratePKCS7Signature = 0x103,
        /// A problem occurred while writing the PKCS#7 signature to the document.
        PSPDFSignerErrorCannotWritePKCS7Signature = 0x104,
        /// The document was signed correctly but couldn't be verified afterwards.
        PSPDFSignerErrorCannotVerifySignature = 0x105,
        /// The signed document could not be created. Check that you have the necessary permissions for the destination folder.
        PSPDFSignerErrorCannotSaveToDestination = 0x106,
        /// The sub-filter type specified to create the signature is not supported.
        PSPDFSignerErrorUnsupportedSubfilterType = 0x107,
        /// Cannot find the signature, either in a new or existing document.
        PSPDFSignerErrorCannotFindSignature = 0x108,
        /// The attributes could not be signed.
        PSPDFSignerErrorCannotSignAttributes = 0x109,
        /// The form element could not be signed.
        PSPDFSignerErrorCannotSignFormElement = 0x110,
        /// The form element is already digitally signed, so it does not make sense to digitally sign it again.
        PSPDFSignerErrorCannotSignAlreadySigned = 0x111,
        /// The byte range of the document could not be hashed.
        PSPDFSignerErrorCouldNotHashDocument = 0x112,
    }

    Swift

    typealias PDFSignerError.Code._ErrorType = PDFSignerError
  • Sound annotation recording and playback states.

    See more

    Declaration

    Objective-C

    enum PSPDFSoundAnnotationState : NSInteger {}

    Swift

    @frozen enum State : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, PSPDFStackViewLayoutDirection) {
        PSPDFStackViewLayoutDirectionHorizontal,
        PSPDFStackViewLayoutDirectionVertical,
    }

    Swift

    @frozen enum Direction : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFStatefulViewState) {
        /// Controller is querying data.
        PSPDFStatefulViewStateLoading,
        /// Controller finished loading, has no data.
        PSPDFStatefulViewStateEmpty,
        /// Controller has data.
        PSPDFStatefulViewStateFinished
    }

    Swift

    @frozen enum StatefulViewState : UInt, @unchecked Sendable
  • Defines the style of the status HUD.

    See more

    Declaration

    Objective-C

    enum PSPDFStatusHUDStyle : NSUInteger {}

    Swift

    @frozen enum Style : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFButtonStyle) {
        /// Single color.
        PSPDFButtonStyleFlat,
        /// Uses blur.
        PSPDFButtonStyleModern,
    }

    Swift

    @frozen enum Style : UInt, @unchecked Sendable
  • Flags for submit-form actions. The names and behaviors of these flags are taken from the PDF reference.

    If none of the format flags .exportFormat, .xfdf, and .submitPDF are specified then the format will be FDF. For FDF, the Content-Type header field will incorrectly be application/vnd.adobe.xfdf. Please contact us if you require the correct type to be used (application/vnd.fdf).

    See more

    Declaration

    Objective-C

    enum PSPDFSubmitFormActionFlag : NSUInteger {}

    Swift

    struct Flag : OptionSet, @unchecked Sendable
  • A visual style of a tabbed bar. This is not used on iOS 13 and above. Instead bar styles are based on UIUserInterfaceStyle.

    See more

    Declaration

    Objective-C

    enum PSPDFTabbedBarStyle : NSUInteger {}

    Swift

    @frozen enum PDFTabbedBarStyle : UInt, @unchecked Sendable
  • Possible values for PDFTabbedViewController’s barHidingMode property.

    See more

    Declaration

    Objective-C

    enum PSPDFTabbedViewControllerBarHidingMode : NSInteger {}

    Swift

    @frozen enum BarHidingMode : Int, @unchecked Sendable
  • Possible values for PDFTabbedViewController’s closeMode property.

    See more

    Declaration

    Objective-C

    enum PSPDFTabbedViewControllerCloseMode : NSInteger {}

    Swift

    @frozen enum CloseMode : Int, @unchecked Sendable
  • Deprecated

    Deprecated in PSPDFKit 10.4 for iOS. These values are not used. Use the properties on TextFormField instead.

    Form field flags specific to text fields, matching bit positions in the PDF specification. These values are not used in PSPDFKit API. Use the properties on TextFormField instead.

    See more

    Declaration

    Objective-C

    enum PSPDFTextFieldFlag : NSUInteger {}

    Swift

    struct TextFieldFlag : OptionSet, @unchecked Sendable
  • An input format for a text form field.

    See more

    Declaration

    Objective-C

    enum PSPDFTextInputFormat : NSUInteger {}

    Swift

    @frozen enum TextInputFormat : UInt, @unchecked Sendable
  • Define the alignment of the thumbnail collection view.

    See more

    Declaration

    Objective-C

    enum PSPDFThumbnailFlowLayoutLineAlignment : NSInteger {}

    Swift

    @frozen enum LineAlignment : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFToolbarButtonControlEvents) {
        /// Custom event for periodic button actions.
        PSPDFControlEventTick = 1 << 24,
    
        /// Similar to `UIControlEventTouchUpInside` but only sent if the button was
        /// not sending `PSPDFControlEventTick` events before the touch up.
        PSPDFControlEventTouchUpInsideIfNotTicking = 1 << 25
    }

    Swift

    struct ControlEvents : OptionSet, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, PSPDFAutosaveReason) {
        /// Called when the view controller was visible but is being dismissed/is disappearing because of another presentation. (`viewDidDisappear`)
        PSPDFAutosaveReasonDisappearing,
        /// The application is moved to background (see `UIApplicationDidEnterBackgroundNotification`)
        PSPDFAutosaveReasonMovingToBackground,
        /// The application is terminating. (see `UIApplicationWillTerminateNotification`)
        PSPDFAutosaveReasonTerminating,
        /// A File conflict has been detected and is being resolved. (see `PSPDFFileConflictResolution`)
        PSPDFAutosaveReasonResolvingFileConflict
    }

    Swift

    enum PSPDFAutosaveReason : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSUInteger, PSPDFWebViewControllerAvailableActions) {
        PSPDFWebViewControllerAvailableActionsNone = 0,
        PSPDFWebViewControllerAvailableActionsOpenInSafari = 1 << 0,
        PSPDFWebViewControllerAvailableActionsMailLink = 1 << 1,
        PSPDFWebViewControllerAvailableActionsCopyLink = 1 << 2,
        PSPDFWebViewControllerAvailableActionsPrint = 1 << 3,
        PSPDFWebViewControllerAvailableActionsStopReload = 1 << 4,
        PSPDFWebViewControllerAvailableActionsBack = 1 << 5,
        PSPDFWebViewControllerAvailableActionsForward = 1 << 6,
        PSPDFWebViewControllerAvailableActionsFacebook = 1 << 7,
        PSPDFWebViewControllerAvailableActionsTwitter = 1 << 8,
        PSPDFWebViewControllerAvailableActionsMessage = 1 << 9,
    
        /// Only offered if Google Chrome is actually installed.
        PSPDFWebViewControllerAvailableActionsOpenInChrome = 1 << 10,
        PSPDFWebViewControllerAvailableActionsAll = 0xFFFFFF,
    }

    Swift

    @frozen enum WebViewControllerAvailableActions : UInt, @unchecked Sendable