Other Enums

Objective-C

enum PSPDFAESCryptoInputStreamErrorCode : NSInteger {}

Swift

typealias AESCryptoInputStreamError.Code._ErrorType = AESCryptoInputStreamError

Objective-C

enum PSPDFAESCryptoOutputStreamErrorCode : NSInteger {}

Swift

typealias AESCryptoOutputStreamError.Code._ErrorType = AESCryptoOutputStreamError

Objective-C

enum PSPDFLineEndType : NSInteger {}

Swift

@frozen enum EndType : Int, @unchecked Sendable

Objective-C

enum PSPDFActionType : UInt8 {}

Swift

@frozen enum Kind : UInt8, @unchecked Sendable

Objective-C

enum PSPDFAnnotationType : NSUInteger {}

Swift

struct Kind : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFAnnotationBorderStyle : NSUInteger {}

Swift

@frozen enum BorderStyle : UInt, @unchecked Sendable

Objective-C

enum PSPDFAnnotationBorderEffect : NSInteger {}

Swift

@frozen enum BorderEffect : Int, @unchecked Sendable

Objective-C

enum PSPDFAnnotationFlags : NSUInteger {}

Swift

struct Flag : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFAnnotationTriggerEvent : UInt8 {}

Swift

@frozen enum TriggerEvent : UInt8, @unchecked Sendable

Objective-C

enum PSPDFAnnotationZIndexMove : NSInteger {}

Swift

@frozen enum ZIndexMove : Int, @unchecked Sendable

Objective-C

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

Swift

@frozen enum VerticalAlignment : UInt, @unchecked Sendable

Objective-C

enum PSPDFAnnotationAuthorStateModel : NSUInteger {}

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

Objective-C

enum PSPDFAnnotationStateManagerStylusMode : NSUInteger {}

Swift

@frozen enum AnnotationStateManagerStylusMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFAnnotationTransformationMode : NSInteger {}

Swift

@frozen enum AnnotationTransformationMode : Int, @unchecked Sendable

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

Objective-C

enum PSPDFBookmarkIndicatorImageType : NSInteger {}

Swift

@frozen enum ImageType : Int, @unchecked Sendable

Objective-C

enum PSPDFBookmarkManagerSortOrder : NSUInteger {}

Swift

@frozen enum SortOrder : UInt, @unchecked Sendable

Objective-C

enum PSPDFIdleTimerManagement : NSUInteger {}

Swift

@frozen enum IdleTimerManagement : UInt, @unchecked Sendable

Objective-C

NS_CLOSED_ENUM(NSInteger, PSPDFCacheStoragePolicy) {
    PSPDFCacheStoragePolicyAutomatic = 0,

    PSPDFCacheStoragePolicyAllowed,
    PSPDFCacheStoragePolicyAllowedInMemoryOnly,
    PSPDFCacheStoragePolicyNotAllowed,
}

Swift

@frozen enum StoragePolicy : Int, @unchecked Sendable

Objective-C

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

Swift

@frozen enum Status : Int, @unchecked Sendable

Objective-C

enum PSPDFCacheImageSizeMatching : NSUInteger {}

Swift

struct ImageSizeMatching : OptionSet, @unchecked Sendable

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

Objective-C

enum PSPDFColorButtonShape : NSInteger {}

Swift

enum Shape : Int, @unchecked Sendable

Objective-C

enum PSPDFColorSet : NSUInteger {}

Swift

@frozen enum ColorSet : UInt, @unchecked Sendable

Objective-C

enum PSPDFPageTransition : NSUInteger {}

Swift

@frozen enum PageTransition : UInt, @unchecked Sendable

Objective-C

enum PSPDFPageMode : NSUInteger {}

Swift

@frozen enum PageMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFScrollDirection : NSUInteger {}

Swift

@frozen enum ScrollDirection : UInt, @unchecked Sendable

Objective-C

enum PSPDFViewMode : NSUInteger {}

Swift

@frozen enum ViewMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFLinkAction : NSUInteger {}

Swift

@frozen enum LinkAction : UInt, @unchecked Sendable

Objective-C

enum PSPDFTextSelectionMode : NSUInteger {}

Swift

@frozen enum TextSelectionMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFDrawCreateMode : NSUInteger {}

Swift

@frozen enum DrawCreateMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFTextSelectionMenuAction : NSUInteger {}

Swift

struct TextSelectionMenuAction : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFThumbnailBarMode : NSUInteger {}

Swift

@frozen enum ThumbnailBarMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFScrubberBarType : NSUInteger {}

Swift

@frozen enum ScrubberBarType : UInt, @unchecked Sendable

Objective-C

enum PSPDFThumbnailGrouping : NSUInteger {}

Swift

@frozen enum ThumbnailGrouping : UInt, @unchecked Sendable

Objective-C

enum PSPDFUserInterfaceViewMode : NSUInteger {}

Swift

@frozen enum UserInterfaceViewMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFUserInterfaceViewAnimation : NSUInteger {}

Swift

@frozen enum UserInterfaceViewAnimation : UInt, @unchecked Sendable

Objective-C

enum PSPDFSearchMode : NSUInteger {}

Swift

@frozen enum SearchMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFRenderStatusViewPosition : NSUInteger {}

Swift

@frozen enum RenderStatusViewPosition : UInt, @unchecked Sendable

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

Objective-C

enum PSPDFAdaptiveConditional : NSUInteger {}

Swift

@frozen enum AdaptiveConditional : UInt, @unchecked Sendable

Objective-C

enum PSPDFScrollInsetAdjustment : NSUInteger {}

Swift

@frozen enum ScrollInsetAdjustment : UInt, @unchecked Sendable

Objective-C

enum PSPDFPageBookmarkIndicatorMode : NSUInteger {}

Swift

@frozen enum PageBookmarkIndicatorMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFSoundAnnotationPlayerStyle : NSUInteger {}

Swift

@frozen enum SoundAnnotationPlayerStyle : UInt, @unchecked Sendable

Objective-C

enum PSPDFSignatureSavingStrategy : NSUInteger {}

Swift

@frozen enum SignatureSavingStrategy : UInt, @unchecked Sendable

Objective-C

enum PSPDFSignatureCertificateSelectionMode : NSUInteger {}

Swift

@frozen enum SignatureCertificateSelectionMode : UInt, @unchecked Sendable

Objective-C

enum PSPDFConfigurationSpreadFitting : NSInteger {}

Swift

@frozen enum SpreadFitting : Int, @unchecked Sendable

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

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

Objective-C

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

Swift

typealias CryptorError.Code._ErrorType = CryptorError

Objective-C

enum PSPDFDataProvidingAdditionalOperations : NSUInteger {}

Swift

struct DataProvidingAdditionalOperations : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDataSinkOptions : NSUInteger {}

Swift

struct DataSinkOptions : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDigitalSignatureReferenceTransformMethod : NSUInteger {}

Swift

@frozen enum TransformMethod : UInt, @unchecked Sendable

Objective-C

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

Swift

@frozen enum FileFormat : Int, @unchecked Sendable

Objective-C

enum PSPDFDocumentSaveStrategy : NSInteger {}

Swift

@frozen enum SaveStrategy : Int, @unchecked Sendable

Objective-C

enum PSPDFJavaScriptStatus : NSInteger {}

Swift

@frozen enum JavaScriptStatus : Int, @unchecked Sendable

Objective-C

enum PSPDFAnnotationSaveMode : NSInteger {}

Swift

@frozen enum AnnotationSaveMode : Int, @unchecked Sendable

Objective-C

enum PSPDFTextCheckingType : NSUInteger {}

Swift

struct TextCheckingType : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDocumentCheckpointingStrategy : NSUInteger {}

Swift

@frozen enum DocumentCheckpointingStrategy : UInt, @unchecked Sendable

Objective-C

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

Swift

@frozen enum PDFDocumentOrientation : Int, @unchecked Sendable

Objective-C

enum PSPDFDocumentEditorInteractiveCapabilities : NSUInteger {}

Swift

struct InteractiveCapabilities : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDocumentPermissions : NSUInteger {}

Swift

struct DocumentPermissions : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDocumentPermissionsLevel : NSUInteger {}

Swift

@frozen enum DocumentPermissionsLevel : UInt, @unchecked Sendable

Objective-C

enum PSPDFDocumentEncryptionAlgorithm : NSUInteger {}

Swift

@frozen enum DocumentEncryptionAlgorithm : UInt, @unchecked Sendable

Objective-C

enum PSPDFDocumentSharingFileFormatOptions : NSUInteger {}

Swift

struct FileFormatOptions : OptionSet, @unchecked Sendable

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

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

Objective-C

enum PSPDFDocumentSharingStep : NSUInteger {}

Swift

@frozen enum Step : UInt, @unchecked Sendable

Objective-C

enum PSPDFDocumentViewLayoutSpreadMode : NSInteger {}

Objective-C

enum PSPDFDocumentViewLayoutPageMode : NSInteger {}

Objective-C

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

Swift

@frozen enum ObjectState : UInt, @unchecked Sendable

Objective-C

enum PSPDFDragType : NSUInteger {}

Swift

struct DragType : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDropType : NSUInteger {}

Swift

struct DropType : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFDropTarget : NSUInteger {}

Swift

struct DropTarget : OptionSet, @unchecked Sendable

Objective-C

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

    /// Touches perform erase operations.
    PSPDFDrawViewInputModeErase
}

Swift

@frozen enum InputMode : Int, @unchecked Sendable

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

Objective-C

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

Swift

@frozen enum Target : UInt, @unchecked Sendable

Objective-C

enum PSPDFErrorCode : NSInteger {}

Swift

typealias PSPDFKitError.Code._ErrorType = PSPDFKitError

Objective-C

enum PSPDFFastScrollDirection : NSInteger {}

Swift

@frozen enum FastScrollDirection : Int, @unchecked Sendable

Objective-C

enum PSPDFFileConflictType : NSUInteger {}

Swift

enum FileConflictType : UInt, @unchecked Sendable

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

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

Objective-C

enum PSPDFFormFieldType : NSUInteger {}

Swift

@frozen enum Kind : UInt, @unchecked Sendable

Objective-C

enum PSPDFSubmitFormActionFormat : NSUInteger {}

Swift

@frozen enum SubmitFormActionFormat : UInt, @unchecked Sendable

Objective-C

enum PSPDFFreeTextAnnotationIntent : NSInteger {}

Swift

@frozen enum Intent : Int, @unchecked Sendable

Objective-C

enum PSPDFGalleryContainerViewContentState : NSUInteger {}

Swift

@frozen enum ContentState : UInt, @unchecked Sendable

Objective-C

enum PSPDFGalleryContainerViewPresentationMode : NSUInteger {}

Swift

@frozen enum PresentationMode : UInt, @unchecked Sendable

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

Objective-C

NS_CLOSED_ENUM(NSInteger, PSPDFGalleryManifestErrorCode) {
    PSPDFGalleryManifestErrorCodeNoDataSourceProvided
}

Swift

@frozen enum PSPDFGalleryManifestErrorCode : Int, @unchecked Sendable

Objective-C

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

Swift

@frozen enum Quality : UInt, @unchecked Sendable

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

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

Objective-C

enum PSPDFImageSaveMode : NSInteger {}

Swift

@frozen enum SaveMode : Int, @unchecked Sendable

Objective-C

enum PSPDFImageQuality : NSUInteger {}

Swift

struct ImageQuality : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFInstantCacheEntryState : NSUInteger {}

Swift

struct InstantCacheEntryState : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFInstantDocumentState : NSInteger {}

Swift

@frozen enum InstantDocumentState : Int, @unchecked Sendable

Objective-C

enum PSPDFInstantErrorCode : NSInteger {}

Swift

typealias InstantError.Code._ErrorType = InstantError

Objective-C

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

Swift

@frozen enum Style : UInt, @unchecked Sendable

Objective-C

enum PSPDFLibraryIndexStatus : NSUInteger {}

Swift

@frozen enum IndexStatus : UInt, @unchecked Sendable

Objective-C

enum PSPDFLibraryFTSVersion : NSUInteger {}

Swift

@frozen enum FTSVersion : UInt, @unchecked Sendable

Objective-C

enum PSPDFLibraryIndexingPriority : NSUInteger {}

Swift

@frozen enum IndexingPriority : UInt, @unchecked Sendable

Objective-C

enum PSPDFLibrarySpotlightIndexingType : NSInteger {}

Swift

@frozen enum SpotlightIndexingType : Int, @unchecked Sendable

Objective-C

NS_CLOSED_ENUM(UInt8, PSPDFLinkAnnotationType) {
    PSPDFLinkAnnotationPage = 0,
    PSPDFLinkAnnotationWebURL,
    PSPDFLinkAnnotationDocument,
    PSPDFLinkAnnotationVideo,
    /// Deprecated. This is for both YouTube and Vimeo.
    PSPDFLinkAnnotationYouTube PSPDF_DEPRECATED(11.4, "Please load videos with direct sources or embed your own player view instead."),
    PSPDFLinkAnnotationAudio,
    PSPDFLinkAnnotationImage,
    PSPDFLinkAnnotationBrowser,
    /// Any annotation format that is not recognized is custom. (e.g. tel://)
    PSPDFLinkAnnotationCustom,
}

Swift

@frozen enum Kind : UInt8, @unchecked Sendable

Objective-C

enum PSPDFLogLevel : NSInteger {}

Swift

enum LogLevel : Int, @unchecked Sendable

Objective-C

enum PSPDFMeasurementPrecision : NSInteger {}

Swift

enum MeasurementPrecision : Int, @unchecked Sendable

Objective-C

enum PSPDFMeasurementMode : NSInteger {}

Swift

enum MeasurementMode : Int, @unchecked Sendable

Objective-C

enum PSPDFUnitFrom : NSInteger {}

Swift

enum UnitFrom : Int, @unchecked Sendable

Objective-C

enum PSPDFUnitTo : NSInteger {}

Swift

enum UnitTo : Int, @unchecked Sendable

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

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

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

Objective-C

enum PSPDFModelEncodingBehavior : NSUInteger {}

Swift

@frozen enum EncodingBehavior : UInt, @unchecked Sendable

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

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

Objective-C

enum PSPDFNewPageType : NSInteger {}

Swift

@frozen enum NewPageType : Int, @unchecked Sendable

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

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

Objective-C

enum PSPDFPresentationHalfModalStyle : NSUInteger {}

Swift

@frozen enum PresentationHalfModalStyle : UInt, @unchecked Sendable

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

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

Objective-C

enum PSPDFAnnotationChange : NSInteger {}

Swift

@frozen enum AnnotationChange : Int, @unchecked Sendable

Objective-C

enum PSPDFItemZPosition : NSInteger {}

Objective-C

enum PSPDFOCRLanguage : NSInteger {}

Swift

enum OCRLanguage : Int, @unchecked Sendable

Objective-C

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

Swift

@frozen enum ReachabilityStatus : UInt, @unchecked Sendable

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

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

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

Objective-C

enum PSPDFRenderRequestCachePolicy : NSInteger {}

Swift

@frozen enum CachePolicy : Int, @unchecked Sendable

Objective-C

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

Swift

@frozen enum Kind : Int, @unchecked Sendable

Objective-C

enum PSPDFResetFormActionFlag : NSUInteger {}

Swift

struct Flag : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFResizableViewOuterKnob : NSUInteger {}

Swift

@frozen enum OuterKnob : UInt, @unchecked Sendable

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

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

Objective-C

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

Swift

@frozen enum MediaScreenWindowType : UInt, @unchecked Sendable

Objective-C

enum PSPDFScrollPerSpreadLayoutContentScale : NSInteger {}

Swift

@frozen enum ContentScale : Int, @unchecked Sendable

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

Objective-C

enum PSPDFSearchBarPinning : NSUInteger {}

Swift

@frozen enum SearchBarPinning : UInt, @unchecked Sendable

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

Objective-C

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

Swift

@frozen enum SelectableCollectionViewCellStyle : UInt, @unchecked Sendable

Objective-C

enum PSPDFSettingsOptions : NSUInteger {}

Swift

struct Options : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFSignatureAppearanceMode : NSUInteger {}

Swift

@frozen enum Mode : UInt, @unchecked Sendable

Objective-C

enum PSPDFDrawInputMethod : NSUInteger {}

Swift

@frozen enum DrawInputMethod : UInt, @unchecked Sendable

Objective-C

enum PSPDFSignatureBiometricPropertiesOption : NSUInteger {}

Swift

struct Option : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFSignatureEncryptionAlgorithm : NSUInteger {}

Swift

@frozen enum PDFSignatureEncryptionAlgorithm : UInt, @unchecked Sendable

Objective-C

enum PSPDFSignatureHashAlgorithm : NSUInteger {}

Swift

@frozen enum PDFSignatureHashAlgorithm : UInt, @unchecked Sendable

Objective-C

enum PSPDFSignatureStatusSeverity : NSInteger {}

Swift

@frozen enum Severity : Int, @unchecked Sendable

Objective-C

enum PSPDFSignatureIntegrityStatus : NSInteger {}

Swift

@frozen enum Integrity : Int, @unchecked Sendable

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

Objective-C

enum PSPDFSoundAnnotationState : NSInteger {}

Swift

@frozen enum State : Int, @unchecked Sendable

Objective-C

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

Swift

@frozen enum Direction : Int, @unchecked Sendable

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

Objective-C

enum PSPDFStatusHUDStyle : NSUInteger {}

Swift

@frozen enum Style : UInt, @unchecked Sendable

Objective-C

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

Swift

@frozen enum Style : UInt, @unchecked Sendable

Objective-C

enum PSPDFSubmitFormActionFlag : NSUInteger {}

Swift

struct Flag : OptionSet, @unchecked Sendable

Objective-C

enum PSPDFTabbedViewControllerBarHidingMode : NSInteger {}

Swift

@frozen enum BarHidingMode : Int, @unchecked Sendable

Objective-C

enum PSPDFTabbedViewControllerCloseMode : NSInteger {}

Swift

@frozen enum CloseMode : Int, @unchecked Sendable

Objective-C

enum PSPDFTextInputFormat : NSUInteger {}

Swift

@frozen enum TextInputFormat : UInt, @unchecked Sendable

Objective-C

enum PSPDFThumbnailFlowLayoutLineAlignment : NSInteger {}

Swift

@frozen enum LineAlignment : Int, @unchecked Sendable

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

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

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