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 {}

    Swift

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

    Note

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

    Declaration

    Objective-C

    enum PSPDFAESCryptoOutputStreamErrorCode {}

    Swift

    typealias PSPDFAESCryptoOutputStreamError.Code._ErrorType = PSPDFAESCryptoOutputStreamError
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, PSPDFLineEndType) {
        PSPDFLineEndTypeNone,
        PSPDFLineEndTypeSquare,
        PSPDFLineEndTypeCircle,
        PSPDFLineEndTypeDiamond,
        PSPDFLineEndTypeOpenArrow,
        PSPDFLineEndTypeClosedArrow,
        PSPDFLineEndTypeButt,
        PSPDFLineEndTypeReverseOpenArrow,
        PSPDFLineEndTypeReverseClosedArrow,
        PSPDFLineEndTypeSlash,
    }

    Swift

    enum PSPDFLineEndType : Int
  • 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 {}

    Swift

    enum PSPDFActionType : UInt8
  • 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 {}

    Swift

    struct AnnotationType : OptionSet
  • Annotation border style types.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationBorderStyle {}

    Swift

    enum PSPDFAnnotationBorderStyle : UInt
  • Border effect names. See PDF Reference 1.5, 1.6. (Table 167).

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationBorderEffect {}

    Swift

    enum PSPDFAnnotationBorderEffect : Int
  • 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 {}

    Swift

    struct PSPDFAnnotationFlags : OptionSet
  • Trigger events for certain viewer actions. See PDF Reference 1.7, 423ff.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationTriggerEvent {}

    Swift

    enum PSPDFAnnotationTriggerEvent : UInt8
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFVerticalAlignment : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFAppearanceMode) {
        /// Normal application appearance.
        PSPDFAppearanceModeDefault = 0,
        /// Renders content with a sepia tone.
        PSPDFAppearanceModeSepia = 1 << 0,
        /// Inverts page content and applies a dark application theme.
        PSPDFAppearanceModeNight = 1 << 1,
        /// All options.
        PSPDFAppearanceModeAll = PSPDFAppearanceModeDefault | PSPDFAppearanceModeSepia | PSPDFAppearanceModeNight
    }

    Swift

    struct PSPDFAppearanceMode : OptionSet
  • Indicates the type of image the bookmark indicator button should use.

    See more

    Declaration

    Objective-C

    enum PSPDFBookmarkIndicatorImageType {}

    Swift

    enum PSPDFBookmarkIndicatorImageType : Int
  • The sort order is currently used for bookmarks.

    See more

    Declaration

    Objective-C

    enum PSPDFBookmarkManagerSortOrder {}

    Swift

    enum PSPDFBookmarkManagerSortOrder : UInt
  • Controls if and how the idle timer should be managed.

    See more

    Declaration

    Objective-C

    enum PSPDFIdleTimerManagement {}

    Swift

    enum PSPDFIdleTimerManagement : UInt
  • Form field flags specific to button fields, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFButtonFlag {}

    Swift

    struct PSPDFButtonFlag : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFCacheStoragePolicy : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFCacheStatus : Int
  • 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 {}

    Swift

    struct PSPDFCacheImageSizeMatching : OptionSet
  • Form field flags specific to choice fields, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFChoiceFlag {}

    Swift

    struct PSPDFChoiceFlag : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFCollectionReusableFilterViewStyle : Int
  • 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 build in color picker in this case).
    See more

    Declaration

    Objective-C

    enum PSPDFColorSet {}

    Swift

    enum PSPDFColorSet : UInt
  • Page Transition. Can be scrolling or something more fancy. See https://pspdfkit.com/guides/ios/current/customizing-the-interface/document-presentation-options/ for further documentation.

    See more

    Declaration

    Objective-C

    enum PSPDFPageTransition {}

    Swift

    enum PSPDFPageTransition : UInt
  • Active page mode.

    See more

    Declaration

    Objective-C

    enum PSPDFPageMode {}

    Swift

    enum PSPDFPageMode : UInt
  • Active scrolling direction. Only relevant for scrolling page transitions.

    See more

    Declaration

    Objective-C

    enum PSPDFScrollDirection {}

    Swift

    enum PSPDFScrollDirection : UInt
  • Current active view mode.

    See more

    Declaration

    Objective-C

    enum PSPDFViewMode {}

    Swift

    enum PSPDFViewMode : UInt
  • Default action for PDF link annotations.

    See more

    Declaration

    Objective-C

    enum PSPDFLinkAction {}

    Swift

    enum PSPDFLinkAction : UInt
  • Defines the text selection mode in PSPDFTextSelectionView. Requires PSPDFFeatureMaskTextSelection to be enabled and textSelectionEnabled set to YES.

    See more

    Declaration

    Objective-C

    enum PSPDFTextSelectionMode {}

    Swift

    enum PSPDFTextSelectionMode : UInt
  • Defines how annotations, which are drawn, are created.

    See more

    Declaration

    Objective-C

    enum PSPDFDrawCreateMode {}

    Swift

    enum PSPDFDrawCreateMode : UInt
  • Menu options when text is selected on this document.

    See more

    Declaration

    Objective-C

    enum PSPDFTextSelectionMenuAction {}

    Swift

    struct PSPDFTextSelectionMenuAction : OptionSet
  • The thumbnail bar mode controls how PSPDFKit displays thumbnails of pages when viewing a document.

    See more

    Declaration

    Objective-C

    enum PSPDFThumbnailBarMode {}

    Swift

    enum PSPDFThumbnailBarMode : UInt
  • Defines where the scrubber but should be shown.

    See more

    Declaration

    Objective-C

    enum PSPDFScrubberBarType {}

    Swift

    enum PSPDFScrubberBarType : UInt
  • Thumbnail grouping setting for PSPDFThumbnailBarModeScrollable and the PSPDFThumbnailViewController.

    See more

    Declaration

    Objective-C

    enum PSPDFThumbnailGrouping {}

    Swift

    enum PSPDFThumbnailGrouping : UInt
  • Defines when the user interface view should be shown.

    See more

    Declaration

    Objective-C

    enum PSPDFUserInterfaceViewMode {}

    Swift

    enum PSPDFUserInterfaceViewMode : UInt
  • Defines how the user interface view should animate.

    See more

    Declaration

    Objective-C

    enum PSPDFUserInterfaceViewAnimation {}

    Swift

    enum PSPDFUserInterfaceViewAnimation : UInt
  • Defines how the search is displayed.

    See more

    Declaration

    Objective-C

    enum PSPDFSearchMode {}

    Swift

    enum PSPDFSearchMode : UInt
  • Defines where the render status should be disaplyed.

    See more

    Declaration

    Objective-C

    enum PSPDFRenderStatusViewPosition {}

    Swift

    enum PSPDFRenderStatusViewPosition : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFTapAction : UInt
  • Defines an adaptive value.

    See more

    Declaration

    Objective-C

    enum PSPDFAdaptiveConditional {}

    Swift

    enum PSPDFAdaptiveConditional : UInt
  • Defines how the scroll view inset should be set.

    See more

    Declaration

    Objective-C

    enum PSPDFScrollInsetAdjustment {}

    Swift

    enum PSPDFScrollInsetAdjustment : UInt
  • Defines when the bookmark indicator should be shown on a page.

    See more

    Declaration

    Objective-C

    enum PSPDFPageBookmarkIndicatorMode {}

    Swift

    enum PSPDFPageBookmarkIndicatorMode : UInt
  • Defines the sound player style used for playing back sound annotations.

    See more

    Declaration

    Objective-C

    enum PSPDFSoundAnnotationPlayerStyle {}

    Swift

    enum PSPDFSoundAnnotationPlayerStyle : UInt
  • Defines if a ink signature should be saved.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureSavingStrategy {}

    Swift

    enum PSPDFSignatureSavingStrategy : UInt
  • Defines if certificate management/selection should be allowed for digitally signing a document.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureCertificateSelectionMode {}

    Swift

    enum PSPDFSignatureCertificateSelectionMode : UInt
  • 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 {}

    Swift

    enum PSPDFConfigurationSpreadFitting : Int
  • Defines the possible biometric properties to store in a digital signature.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureBiometricPropertiesOption {}

    Swift

    struct PSPDFSignatureBiometricPropertiesOption : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFMarkupAnnotationMergeBehavior : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ERROR_ENUM(PSPDFCryptorErrorDomain, PSPDFCryptorErrorCode) {
        PSPDFCryptorErrorFailedToInitCryptor = 100,
        PSPDFCryptorErrorFailedToProcessFile = 110,
        PSPDFCryptorErrorInvalidIV = 200,
        PSPDFCryptorErrorWritingOutputFile = 600,
        PSPDFCryptorErrorReadingInputFile = 700,
    }
  • Specifies which types of operations the data provider supports. Every data provider must support reading.

    See more

    Declaration

    Objective-C

    enum PSPDFDataProvidingAdditionalOperations {}

    Swift

    struct PSPDFDataProvidingAdditionalOperations : OptionSet
  • 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 {}

    Swift

    enum PSPDFDigitalSignatureReferenceTransformMethod : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFDiskCacheFileFormat : Int
  • Returns if JavaScript code can execute on this document.

    See more

    Declaration

    Objective-C

    enum PSPDFJavaScriptStatus {}

    Swift

    enum PSPDFJavaScriptStatus : Int
  • Annotations can be saved in the PDF or alongside in an external file.

    See more

    Declaration

    Objective-C

    enum PSPDFAnnotationSaveMode {}

    Swift

    enum PSPDFAnnotationSaveMode : Int
  • Creates annotations based on the text content. See detectLinkTypes:forPagesInRange:.

    See more

    Declaration

    Objective-C

    enum PSPDFTextCheckingType {}

    Swift

    struct PSPDFTextCheckingType : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFDocumentOrientation : Int
  • 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 {}

    Swift

    struct PSPDFDocumentPermissions : OptionSet
  • An enumeration that specifies document permissions level.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentPermissionsLevel {}

    Swift

    enum PSPDFDocumentPermissionsLevel : UInt
  • The algorithm to use to encrypt a document.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentEncryptionAlgorithm {}

    Swift

    enum PSPDFDocumentEncryptionAlgorithm : UInt
  • The possible file formats that can be used for sharing documents.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentSharingFileFormatOptions {}

    Swift

    struct PSPDFDocumentSharingFileFormatOptions : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFDocumentSharingPagesOptions) {
        /// Only the page set in `pageIndex` of `PSPDFViewController`.
        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 PSPDFDocumentSharingPagesOptions : OptionSet
  • 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/current/miscellaneous/3rd-party-compatibility/)
         */
        PSPDFDocumentSharingAnnotationOptionEmbed = 1 << 0,
    
        /// Render annotations into the PDF.
        PSPDFDocumentSharingAnnotationOptionFlatten = 1 << 1,
    
        /// Render annotations into the PDF. Converts notes to printable text.
        PSPDFDocumentSharingAnnotationOptionFlattenForPrint = 1 << 2,
    
        /// Save annotations + add summary. Not available on macOS.
        PSPDFDocumentSharingAnnotationOptionSummary = 1 << 3,
    
        /// Remove all annotations.
        PSPDFDocumentSharingAnnotationOptionRemove = 1 << 4
    }

    Swift

    struct PSPDFDocumentSharingAnnotationOptions : OptionSet
  • Defines a moment in the sharing process.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentSharingStep {}

    Swift

    enum PSPDFDocumentSharingStep : UInt
  • The spread mode determines the conversion between spreads and pages.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentViewLayoutSpreadMode {}

    Swift

    enum PSPDFDocumentViewLayoutSpreadMode : Int
  • The page mode determines how a page is displayed relative to its neighbouring pages.

    See more

    Declaration

    Objective-C

    enum PSPDFDocumentViewLayoutPageMode {}

    Swift

    enum PSPDFDocumentViewLayoutPageMode : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFDownloadManagerObjectState : UInt
  • Defines the types of items that are dragged.

    See more

    Declaration

    Objective-C

    enum PSPDFDragType {}

    Swift

    struct PSPDFDragType : OptionSet
  • Defines the types of items that are dropped.

    See more

    Declaration

    Objective-C

    enum PSPDFDropType {}

    Swift

    struct PSPDFDropType : OptionSet
  • Defines targets where drops can happen.

    See more

    Declaration

    Objective-C

    enum PSPDFDropTarget {}

    Swift

    struct PSPDFDropTarget : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFDrawViewInputMode : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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
    }

    Swift

    enum PSPDFEditingOperation : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFEmbeddedGoToActionTarget : UInt
  • List of documented errors within the PSPDFErrorDomain.

    Note

    Various PSPDFKit method can also returns errors from Apple-internal error domains.
    See more

    Declaration

    Objective-C

    enum PSPDFErrorCode {}

    Swift

    typealias PSPDFError.Code._ErrorType = PSPDFError
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFFlexibleToolbarPosition) {
        PSPDFFlexibleToolbarPositionNone = 0,
        PSPDFFlexibleToolbarPositionInTopBar = 1 << 0,
        PSPDFFlexibleToolbarPositionLeft = 1 << 1,
        PSPDFFlexibleToolbarPositionRight = 1 << 2,
        PSPDFFlexibleToolbarPositionsVertical = PSPDFFlexibleToolbarPositionLeft | PSPDFFlexibleToolbarPositionRight,
        PSPDFFlexibleToolbarPositionsAll = PSPDFFlexibleToolbarPositionInTopBar | PSPDFFlexibleToolbarPositionsVertical,
    }

    Swift

    struct PSPDFFlexibleToolbarPosition : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, PSPDFToolbarGroupButtonIndicatorPosition) {
        PSPDFToolbarGroupButtonIndicatorPositionNone = 0,
        PSPDFToolbarGroupButtonIndicatorPositionBottomLeft,
        PSPDFToolbarGroupButtonIndicatorPositionBottomRight,
    }

    Swift

    enum PSPDFToolbarGroupButtonIndicatorPosition : Int
  • Flags common to all form field types, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFFormElementFlag {}

    Swift

    struct PSPDFFormElementFlag : OptionSet
  • Defines all the available types a form field can be.

    See more

    Declaration

    Objective-C

    enum PSPDFFormFieldType {}

    Swift

    enum PSPDFFormFieldType : UInt
  • The possible formats a form submission can be encoded in.

    See more

    Declaration

    Objective-C

    enum PSPDFSubmitFormActionFormat {}

    Swift

    enum PSPDFSubmitFormActionFormat : UInt
  • The free text annotation intent type. (Optional; PDF 1.6)

    See more

    Declaration

    Objective-C

    enum PSPDFFreeTextAnnotationIntent {}

    Swift

    enum PSPDFFreeTextAnnotationIntent : Int
  • PSPDFGalleryContainerViewContentState controls which content view will be visible.

    See more

    Declaration

    Objective-C

    enum PSPDFGalleryContainerViewContentState {}

    Swift

    enum PSPDFGalleryContainerViewContentState : UInt
  • PSPDFGalleryContainerViewPresentationMode controls which background view will be visible.

    See more

    Declaration

    Objective-C

    enum PSPDFGalleryContainerViewPresentationMode {}

    Swift

    enum PSPDFGalleryContainerViewPresentationMode : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFGalleryItemContentState : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, PSPDFGalleryManifestErrorCode) {
        PSPDFGalleryManifestErrorCodeNoDataSourceProvided
    }

    Swift

    enum PSPDFGalleryManifestErrorCode : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFGalleryVideoItemQuality : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFGalleryVideoItemCoverMode : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFGalleryViewControllerState : UInt
  • Used to customize the image quality options offered for adding images.

    See more

    Declaration

    Objective-C

    enum PSPDFImageQuality {}

    Swift

    struct PSPDFImageQuality : OptionSet
  • Bitmask for diagnostics of a cache entry.

    See more

    Declaration

    Objective-C

    enum PSPDFInstantCacheEntryState {}

    Swift

    struct PSPDFInstantCacheEntryState : OptionSet
  • 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 {}

    Swift

    enum PSPDFInstantDocumentState : Int
  • Declares all possible feature flags in a license.

    See more

    Declaration

    Objective-C

    enum PSPDFFeatureMask {}

    Swift

    struct PSPDFFeatureMask : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFLabelStyle : UInt
  • Represents the status of a document in the library.

    See more

    Declaration

    Objective-C

    enum PSPDFLibraryIndexStatus {}

    Swift

    enum PSPDFLibraryIndexStatus : UInt
  • Specifies the version of FTS the PSPDFLibrary should use.

    See more

    Declaration

    Objective-C

    enum PSPDFLibraryFTSVersion {}

    Swift

    enum PSPDFLibraryFTSVersion : UInt
  • Specifies the priority indexing takes in task scheduling.

    See more

    Declaration

    Objective-C

    enum PSPDFLibraryIndexingPriority {}

    Swift

    enum PSPDFLibraryIndexingPriority : UInt
  • Specifies what data is to be indexed to Spotlight.

    See more

    Declaration

    Objective-C

    enum PSPDFLibrarySpotlightIndexingType {}

    Swift

    enum PSPDFLibrarySpotlightIndexingType : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(UInt8, PSPDFLinkAnnotationType) {
        PSPDFLinkAnnotationPage = 0,
        PSPDFLinkAnnotationWebURL,
        PSPDFLinkAnnotationDocument,
        PSPDFLinkAnnotationVideo,
        PSPDFLinkAnnotationYouTube,
        PSPDFLinkAnnotationAudio,
        PSPDFLinkAnnotationImage,
        PSPDFLinkAnnotationBrowser,
        /// Any annotation format that is not recognized is custom. (e.g. tel://)
        PSPDFLinkAnnotationCustom,
    }

    Swift

    enum PSPDFLinkAnnotationType : UInt8
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFLogLevelMask) {
        /// Log nothing.
        PSPDFLogLevelMaskNothing = 0,
    
        /**
         Logs critical issues, that can break or limit the functionality of the framework.
         Should never be disabled.
         */
        PSPDFLogLevelMaskCritical = 1 << 0,
    
        /// Logs errors. Should never be disabled.
        PSPDFLogLevelMaskError = 1 << 1,
    
        /// Logs issues that are not errors or critical, but log-worthy.
        PSPDFLogLevelMaskWarning = 1 << 2,
    
        /// Logs important operations.
        PSPDFLogLevelMaskInfo = 1 << 3,
    
        /// Will log almost everything and slow down the application flow.
        PSPDFLogLevelMaskDebug = 1 << 4,
    
        /**
         Might log security related details like signature points.
         Never enable this in release builds unless they are solely for testing.
         */
        PSPDFLogLevelMaskVerbose = 1 << 5,
    
        /// Enables all logging categories.
        PSPDFLogLevelMaskAll = UINT_MAX,
    }

    Swift

    struct PSPDFLogLevelMask : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFMediaPlayerControlStyle : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFMediaPlayerControllerContentState : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFMediaPlayerCoverMode : UInt
  • Defines how a PSPDFModel property key should be encoded into an archive.

    See more

    Declaration

    Objective-C

    enum PSPDFModelEncodingBehavior {}

    Swift

    enum PSPDFModelEncodingBehavior : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFNamedActionType) {
        PSPDFNamedActionTypeNone,
        PSPDFNamedActionTypeNextPage,
        PSPDFNamedActionTypePreviousPage,
        PSPDFNamedActionTypeFirstPage,
        PSPDFNamedActionTypeLastPage,
        PSPDFNamedActionTypeGoBack,
        PSPDFNamedActionTypeGoForward,
        PSPDFNamedActionTypeGoToPage,
        PSPDFNamedActionTypeFind,
        PSPDFNamedActionTypePrint,
        PSPDFNamedActionTypeOutline,
        PSPDFNamedActionTypeSearch,
        PSPDFNamedActionTypeBrightness,
        /// not implemented
        PSPDFNamedActionTypeZoomIn,
        /// not implemented
        PSPDFNamedActionTypeZoomOut,
        /// Triggers `[document saveChangedAnnotationsWithError:]`
        PSPDFNamedActionTypeSaveAs,
        PSPDFNamedActionTypeInfo,
        PSPDFNamedActionTypeUnknown = NSUIntegerMax,
    }

    Swift

    enum PSPDFNamedActionType : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFPersistentCloseButtonMode) {
        /// No persistent close button.
        PSPDFPersistentCloseButtonModeNone,
        /// Persistent close button on the left.
        PSPDFPersistentCloseButtonModeLeft,
        /// Persistent close button on the right.
        PSPDFPersistentCloseButtonModeRight
    }

    Swift

    enum PSPDFPersistentCloseButtonMode : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFPageTriggerEvent : UInt
  • The type of new page that will be added

    See more

    Declaration

    Objective-C

    enum PSPDFNewPageType {}

    Swift

    enum PSPDFNewPageType : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFPolygonAnnotationIntent : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFPresentationStyle : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFPrintMode : UInt
  • 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 {}

    Swift

    enum PSPDFAnnotationChange : Int
  • Specifies if the item (image) should be located in the foreground or background

    See more

    Declaration

    Objective-C

    enum PSPDFItemZPosition {}

    Swift

    enum PSPDFItemZPosition : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFReachability : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFRenderType : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, PSPDFRenderFilter) {
        /// If set, a grayscale filter will be applied.
        PSPDFRenderFilterGrayscale = 1 << 0,
    
        /// If set and the `PSPDFRenderInvertedKey` key is present, 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 PSPDFRenderFilter : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFRenderQueuePriority : UInt
  • The render request cache policy controls if and how the request, once scheduled, access the cache.

    See more

    Declaration

    Objective-C

    enum PSPDFRenderRequestCachePolicy {}

    Swift

    enum PSPDFRenderRequestCachePolicy : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFRenditionActionType : Int
  • Flags for reset-form actions, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFResetFormActionFlag {}

    Swift

    struct PSPDFResetFormActionFlag : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFResizableViewOuterKnob) {
        PSPDFResizableViewOuterKnobUnknown,
        PSPDFResizableViewOuterKnobTopLeft,
        PSPDFResizableViewOuterKnobTopMiddle,
        PSPDFResizableViewOuterKnobTopRight,
        PSPDFResizableViewOuterKnobMiddleLeft,
        PSPDFResizableViewOuterKnobMiddleRight,
        PSPDFResizableViewOuterKnobBottomLeft,
        PSPDFResizableViewOuterKnobBottomMiddle,
        PSPDFResizableViewOuterKnobBottomRight,
    }

    Swift

    enum PSPDFResizableViewOuterKnob : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFKnobType) {
        /// Used to resize the bounding box.
        PSPDFKnobTypeOuter,
        /// Used to alter certain shapes.
        PSPDFKnobTypeInner
    }

    Swift

    enum PSPDFKnobType : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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
    }

    Swift

    enum PSPDFResizableViewMode : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFMediaScreenWindowType : UInt
  • The content scale describes how each spread lays out its content.

    See more

    Declaration

    Objective-C

    enum PSPDFScrollPerSpreadLayoutContentScale {}

    Swift

    enum PSPDFScrollPerSpreadLayoutContentScale : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFSearchStatus : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFSearchBarPinning) {
        /// Pin unless in a popover presentation.
        PSPDFSearchBarPinningAuto,
        /// Pin search bar to top.
        PSPDFSearchBarPinningTop,
        /// Embed the search bar inside the table view.
        PSPDFSearchBarPinningNone,
    }

    Swift

    enum PSPDFSearchBarPinning : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFSearchResultScope : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFSelectableCollectionViewCellStyle : UInt
  • Configures the style of a digital signature.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureAppearanceMode {}

    Swift

    enum PSPDFSignatureAppearanceMode : UInt
  • The different kinds of input methods we support for creating a handwritten signature.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureInputMethod {}

    Swift

    enum PSPDFSignatureInputMethod : UInt
  • The supported encryption algorithms that can be used when signing a document.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureEncryptionAlgorithm {}

    Swift

    enum PSPDFSignatureEncryptionAlgorithm : UInt
  • 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 {}

    Swift

    enum PSPDFSignatureHashAlgorithm : UInt
  • Severity of a signature validation problem

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureStatusSeverity {}

    Swift

    enum PSPDFSignatureStatusSeverity : Int
  • Integrity status of a signature field.

    See more

    Declaration

    Objective-C

    enum PSPDFSignatureIntegrityStatus {}

    Swift

    enum PSPDFSignatureIntegrityStatus : Int
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ERROR_ENUM(PSPDFSignerErrorDomain, PSPDFSignerError) {
        /// 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 subfilter 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,
    }

    Swift

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

    See more

    Declaration

    Objective-C

    enum PSPDFSoundAnnotationState {}

    Swift

    enum PSPDFSoundAnnotationState : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFStackViewLayoutDirection : Int
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFStatefulViewState : UInt
  • Defines the style of the status HUD.

    See more

    Declaration

    Objective-C

    enum PSPDFStatusHUDStyle {}

    Swift

    enum PSPDFStatusHUDStyle : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

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

    Swift

    enum PSPDFButtonStyle : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFStylusConnectionStatus) {
        PSPDFStylusConnectionStatusOff,
        PSPDFStylusConnectionStatusScanning,
        PSPDFStylusConnectionStatusPairing,
        PSPDFStylusConnectionStatusConnected,
        PSPDFStylusConnectionStatusDisconnected,
    }

    Swift

    enum PSPDFStylusConnectionStatus : UInt
  • Defines classifications for a stylus touch and how a touch should be handled.

    See more

    Declaration

    Objective-C

    enum PSPDFStylusTouchClassification {}

    Swift

    enum PSPDFStylusTouchClassification : Int
  • Flags for submit-form actions, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFSubmitFormActionFlag {}

    Swift

    struct PSPDFSubmitFormActionFlag : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFTabbedBarStyle) {
        PSPDFTabbedBarStyleLight,
        PSPDFTabbedBarStyleDark,
    }

    Swift

    enum PSPDFTabbedBarStyle : UInt
  • Form field flags specific to text fields, matching bit positions in the PDF specification.

    See more

    Declaration

    Objective-C

    enum PSPDFTextFieldFlag {}

    Swift

    struct PSPDFTextFieldFlag : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFTextInputFormat) {
        PSPDFTextInputFormatNormal,
        PSPDFTextInputFormatNumber,
        PSPDFTextInputFormatDate,
        PSPDFTextInputFormatTime,
    }

    Swift

    enum PSPDFTextInputFormat : UInt
  • Define the alignment of the thumbnail collection view.

    See more

    Declaration

    Objective-C

    enum PSPDFThumbnailFlowLayoutLineAlignment {}

    Swift

    enum PSPDFThumbnailFlowLayoutLineAlignment : Int
  • 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 PSPDFToolbarButtonControlEvents : OptionSet
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, PSPDFUndoCoalescing) {
        /// Does not coalesce events with the same key at all but rather creates one new undo event for every single change.
        PSPDFUndoCoalescingNone,
    
        /// Coalesces events with the same key by time. Assuming that a key changes a number of times over a
        /// short period of time, only the initial value will be recorded.
        PSPDFUndoCoalescingTimed,
    
        /// Puts all subsequent changes to one key into the same group. This means that constant changes
        /// of the same value will result in exactly one event, which restores the property to its initial value.
        PSPDFUndoCoalescingAll
    }

    Swift

    enum PSPDFUndoCoalescing : UInt
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_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

    enum PSPDFWebViewControllerAvailableActions : UInt