Other Constants

The following constants are available globally.

(Extended) annotation types and names


                    
                    
                    PTExtendedAnnotNameImageStamp

Image stamp annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNameImageStamp

Swift

static let imageStamp: PTExtendedAnnotName


                    
                    
                    PTExtendedAnnotNameRuler

Ruler annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNameRuler

Swift

static let ruler: PTExtendedAnnotName


                    
                    
                    PTExtendedAnnotNamePerimeter

Perimeter annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNamePerimeter

Swift

static let perimeter: PTExtendedAnnotName


                    
                    
                    PTExtendedAnnotNameArea

Area annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNameArea

Swift

static let area: PTExtendedAnnotName


                    
                    
                    PTExtendedAnnotNamePencilDrawing

Pencil drawing annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNamePencilDrawing

Swift

static let pencilDrawing: PTExtendedAnnotName


                    
                    
                    PTExtendedAnnotNameFreehandHighlight

Freehand highlight annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNameFreehandHighlight

Swift

static let freehandHighlight: PTExtendedAnnotName


                    
                    
                    PTExtendedAnnotNameCallout

Free text callout annotation

Declaration

Objective-C

extern const PTExtendedAnnotName _Nonnull PTExtendedAnnotNameCallout

Swift

static let callout: PTExtendedAnnotName

PTSignatureAnnotationIdentifier
An identifying string applied to signature (stamp) annotations.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTSignatureAnnotationIdentifier
Swift

let PTSignatureAnnotationIdentifier: String
PTImageStampAnnotationIdentifier
An identifying string applied to image (stamp) annotations.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTImageStampAnnotationIdentifier
Swift

let PTImageStampAnnotationIdentifier: String
PTImageStampAnnotationRotationIdentifier
An identifying string applied to image (stamp) annotations relating to the stamp’s rotation.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTImageStampAnnotationRotationIdentifier
Swift

let PTImageStampAnnotationRotationIdentifier: String
PTImageStampAnnotationRotationDegreeIdentifier
An identifying string applied to image (stamp) annotations relating to the stamp’s rotation.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTImageStampAnnotationRotationDegreeIdentifier
Swift

let PTImageStampAnnotationRotationDegreeIdentifier: String
PTPencilDrawingAnnotationIdentifier
An identifying string applied to image (stamp) annotations created with PencilKit.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPencilDrawingAnnotationIdentifier
Swift

let PTPencilDrawingAnnotationIdentifier: String

PTPDFViewCtrl Notifications

PTPDFViewCtrlDidCloseDocNotification
Posted when the PTPDFViewCtrl has closed the current document.

The notification object is the pdfViewCtrl that posted the notification. The userInfo dictionary is empty.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTPDFViewCtrlDidCloseDocNotification
Swift

static let PTPDFViewCtrlDidCloseDoc: NSNotification.Name
PTPDFViewCtrlStreamingEventNotification
Posted when the PTPDFViewCtrl has streaming event notification. These are generated when downloading a document via -OpenURLAync:, and when opening a non-PDF document with -openUniversalDocumentWithConversion:.

The notification object is the pdfViewCtrl that posted the notification. The userInfo dictionary contains entries for the PTPDFViewCtrlStreamingEventTypeUserInfoKey and PTPDFViewCtrlPageNumberUserInfoKey keys. The PTPDFViewCtrlStreamingEventMessageUserInfoKey key is present when there is a streaming event message.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTPDFViewCtrlStreamingEventNotification
Swift

static let PTPDFViewCtrlStreamingEvent: NSNotification.Name
PTPDFViewCtrlColorPostProcessModeDidChangeNotification
Posted when the PTPDFViewCtrl’s color post process mode changes.

The notification object is the pdfViewCtrl that posted the notification. The userInfo dictionary contains entries for the PTPDFViewCtrlColorPostProcessModeUserInfoKey and PTPDFViewCtrlPageNumberUserInfoKey keys. It may also contain entries for the PTPDFViewCtrlWhiteColorUserInfoKey and PTPDFViewCtrlBlackColorUserInfoKey keys when the post-process colors are changed with -SetColorPostProcessColors:black_color:.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTPDFViewCtrlColorPostProcessModeDidChangeNotification
Swift

static let PTPDFViewCtrlColorPostProcessModeDidChange: NSNotification.Name
PTPDFViewCtrlPagePresentationModeDidChangeNotification
Posted when the PTPDFViewCtrl’s page presentation mode changes.

The notification object is the PTPDFViewCtrl that posted the notification. The userInfo dictionary contains an entry for the PTPDFViewCtrlPagePresentationModeUserInfoKey key with the new page presentation mode.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTPDFViewCtrlPagePresentationModeDidChangeNotification
Swift

static let PTPDFViewCtrlPagePresentationModeDidChange: NSNotification.Name

User info keys

PTPDFViewCtrlPageNumberUserInfoKey
The key for a NSNumber object containing an int page number.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlPageNumberUserInfoKey
Swift

let PTPDFViewCtrlPageNumberUserInfoKey: String
PTPDFViewCtrlStreamingEventTypeUserInfoKey
The key for a NSNumber object containing a PTDownloadedType.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlStreamingEventTypeUserInfoKey
Swift

let PTPDFViewCtrlStreamingEventTypeUserInfoKey: String
PTPDFViewCtrlStreamingEventMessageUserInfoKey
The key for a NSString object containing the message for a streaming event.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlStreamingEventMessageUserInfoKey
Swift

let PTPDFViewCtrlStreamingEventMessageUserInfoKey: String
PTPDFViewCtrlColorPostProcessModeUserInfoKey
The key for a NSNumber object containing a PTColorPostProcessMode.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlColorPostProcessModeUserInfoKey
Swift

let PTPDFViewCtrlColorPostProcessModeUserInfoKey: String
PTPDFViewCtrlBlackColorUserInfoKey
The key for a UIColor object containing the color that black is mapped to.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlBlackColorUserInfoKey
Swift

let PTPDFViewCtrlBlackColorUserInfoKey: String
PTPDFViewCtrlWhiteColorUserInfoKey
The key for a UIColor object containing the color that white is mapped to.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlWhiteColorUserInfoKey
Swift

let PTPDFViewCtrlWhiteColorUserInfoKey: String
PTPDFViewCtrlPagePresentationModeUserInfoKey
The key for a NSNumber object containing a TrnPagePresentationMode.
See more
Declaration
Objective-C

extern NSString *const _Nonnull PTPDFViewCtrlPagePresentationModeUserInfoKey
Swift

let PTPDFViewCtrlPagePresentationModeUserInfoKey: String


                    
                    
                    PTAnnotStyleKeyBorderEffect

Annotation border effect.

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeyBorderEffect

Swift

static let borderEffect: PTAnnotStyleKey


                    
                    
                    PTAnnotStyleKeyBorderEffectIntensity

Annotation border effect intensity.

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeyBorderEffectIntensity

Swift

static let borderEffectIntensity: PTAnnotStyleKey


                    
                    
                    PTAnnotStyleKeyLabel

Annotation label.

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeyLabel

Swift

static let label: PTAnnotStyleKey


                    
                    
                    PTAnnotStyleKeyScale

Measurement scale.

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeyScale

Swift

static let scale: PTAnnotStyleKey


                    
                    
                    PTAnnotStyleKeyPrecision

Measurement precision.

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeyPrecision

Swift

static let precision: PTAnnotStyleKey


                    
                    
                    PTAnnotStyleKeySnapping

Measurement tool snap-to.

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeySnapping

Swift

static let snapping: PTAnnotStyleKey


                    
                    
                    PTAnnotStyleKeyFont

Annotation font

Declaration

Objective-C

extern const PTAnnotStyleKey _Nonnull PTAnnotStyleKeyFont

Swift

static let font: PTAnnotStyleKey

Notifications

PTCollaborationManagerRemoteAnnotationsAddedNotification
Posted when remote annotations are added.

The notification object is the collaboration manager that posted the notification. The userInfo dictionary contains entries for the PTCollaborationManagerAnnotationUserInfoKey key.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTCollaborationManagerRemoteAnnotationsAddedNotification
Swift

static let PTCollaborationManagerRemoteAnnotationsAdded: NSNotification.Name
PTCollaborationManagerRemoteAnnotationsModifiedNotification
Posted when remote annotations are modified.

The notification object is the collaboration manager that posted the notification. The userInfo dictionary contains entries for the PTCollaborationManagerAnnotationUserInfoKey key.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTCollaborationManagerRemoteAnnotationsModifiedNotification
Swift

static let PTCollaborationManagerRemoteAnnotationsModified: NSNotification.Name
PTCollaborationManagerRemoteAnnotationsRemovedNotification
Posted when remote annotations are removed.

The notification object is the collaboration manager that posted the notification. The userInfo dictionary contains entries for the PTCollaborationManagerAnnotationUserInfoKey key.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTCollaborationManagerRemoteAnnotationsRemovedNotification
Swift

static let PTCollaborationManagerRemoteAnnotationsRemoved: NSNotification.Name

Notification user info keys


                    
                    
                    PTCollaborationManagerAnnotationsUserInfoKey

The key for an NSArray of PTCollaborationAnnotation objects.

Declaration

Objective-C

extern NSString *const _Nonnull PTCollaborationManagerAnnotationsUserInfoKey

Swift

let PTCollaborationManagerAnnotationsUserInfoKey: String


                    
                    
                    PTCollaborationManagerIsInitialUserInfoKey

The key for an NSNumber object containing a BOOL.

Declaration

Objective-C

extern NSString *const _Nonnull PTCollaborationManagerIsInitialUserInfoKey

Swift

let PTCollaborationManagerIsInitialUserInfoKey: String

Notifications

PTDocumentViewControllerDidOpenDocumentNotification
Posted when the PTDocumentViewController has opened a document.

The notification object is the PTDocumentViewController that posted the notification.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTDocumentViewControllerDidOpenDocumentNotification
Swift

static let PTDocumentViewControllerDidOpenDocument: NSNotification.Name


                    
                    
                    PTDocumentViewControllerDidDissmissShareActivityNotification

Undocumented

Declaration

Objective-C

PT_EXPORT const NSNotificationName PTDocumentViewControllerDidDissmissShareActivityNotification

Swift

static let PTDocumentViewControllerDidDissmissShareActivity: NSNotification.Name


                    
                    
                    PTDocumentViewControllerDidDissapearNotification

Undocumented

Declaration

Objective-C

PT_EXPORT const NSNotificationName PTDocumentViewControllerDidDissapearNotification

Swift

static let PTDocumentViewControllerDidDissapear: NSNotification.Name


                    
                    
                    PTStampTypeCheckMark

A checkmark-type stamp.

Declaration

Objective-C

extern const PTStampType _Nonnull PTStampTypeCheckMark

Swift

static let checkMark: PTStampType


                    
                    
                    PTStampTypeCrossMark

A cross-type stamp.

Declaration

Objective-C

extern const PTStampType _Nonnull PTStampTypeCrossMark

Swift

static let crossMark: PTStampType


                    
                    
                    PTStampTypeDot

A dot-type stamp.

Declaration

Objective-C

extern const PTStampType _Nonnull PTStampTypeDot

Swift

static let dot: PTStampType


                    
                    
                    PTRubberStampKeyText

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyText

Swift

let PTRubberStampKeyText: String


                    
                    
                    PTRubberStampKeyTextBelow

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyTextBelow

Swift

let PTRubberStampKeyTextBelow: String


                    
                    
                    PTRubberStampKeyFillColorStart

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyFillColorStart

Swift

let PTRubberStampKeyFillColorStart: String


                    
                    
                    PTRubberStampKeyFillColorEnd

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyFillColorEnd

Swift

let PTRubberStampKeyFillColorEnd: String


                    
                    
                    PTRubberStampKeyTextColor

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyTextColor

Swift

let PTRubberStampKeyTextColor: String


                    
                    
                    PTRubberStampKeyBorderColor

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyBorderColor

Swift

let PTRubberStampKeyBorderColor: String


                    
                    
                    PTRubberStampKeyFillOpacity

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyFillOpacity

Swift

let PTRubberStampKeyFillOpacity: String


                    
                    
                    PTRubberStampKeyPointingLeft

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyPointingLeft

Swift

let PTRubberStampKeyPointingLeft: String


                    
                    
                    PTRubberStampKeyPointingRight

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTRubberStampKeyPointingRight

Swift

let PTRubberStampKeyPointingRight: String


                    
                    
                    PTTextSearchMatchCaseKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTTextSearchMatchCaseKey

Swift

let PTTextSearchMatchCaseKey: String


                    
                    
                    PTTextSearchMatchWholeWordKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTTextSearchMatchWholeWordKey

Swift

let PTTextSearchMatchWholeWordKey: String

PTThumbnailViewLayoutDefaultSpacing
The default line, interitem, and section inset spacing.
See more
Declaration
Objective-C

extern const CGFloat PTThumbnailViewLayoutDefaultSpacing
Swift

let PTThumbnailViewLayoutDefaultSpacing: CGFloat


                    
                    
                    PTThumbnailFilterAll

A filter to show all thumbnails.

Declaration

Objective-C

extern const PTFilterMode _Nonnull PTThumbnailFilterAll

Swift

static let thumbnailFilterAll: PTFilterMode


                    
                    
                    PTThumbnailFilterAnnotated

A filter to show thumbnails of annotated pages only.

Declaration

Objective-C

extern const PTFilterMode _Nonnull PTThumbnailFilterAnnotated

Swift

static let thumbnailFilterAnnotated: PTFilterMode


                    
                    
                    PTThumbnailFilterBookmarked

A filter to show thumbnails of bookmarked pages only.

Declaration

Objective-C

extern const PTFilterMode _Nonnull PTThumbnailFilterBookmarked

Swift

static let thumbnailFilterBookmarked: PTFilterMode

PTToolGroupDidChangeNotification
This notification is posted when the selected tool group changes.

The notification object is the tool group manager that posted the notification.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolGroupDidChangeNotification
Swift

static let PTToolGroupDidChange: NSNotification.Name
PTToolManagerToolWillChangeNotification
Posted when the tool will be changed.

The notification object is the tool manager that posted the notification. The userInfo dictionary contains an entry for the PTToolManagerToolUserInfoKey key when there is a next tool.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolManagerToolWillChangeNotification
Swift

static let PTToolManagerToolWillChange: NSNotification.Name
PTToolManagerAnnotationWillModifyNotification
Posted when an annotation will be modified.

The notification object is the tool manager that posted the notification. The userInfo dictionary contains entries for the PTToolManagerAnnotationUserInfoKey and PTToolManagerPageNumberUserInfoKey keys.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolManagerAnnotationWillModifyNotification
Swift

static let PTToolManagerAnnotationWillModify: NSNotification.Name
PTToolManagerAnnotationWillRemoveNotification
Posted when an annotation will be removed.

The notification object is the tool manager that posted the notification. The userInfo dictionary contains entries for the PTToolManagerAnnotationUserInfoKey and PTToolManagerPageNumberUserInfoKey keys.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolManagerAnnotationWillRemoveNotification
Swift

static let PTToolManagerAnnotationWillRemove: NSNotification.Name
PTToolManagerPageAddedNotification
Posted when a page is added to the document.

The notification object is the tool manager that posted the notification. The userInfo dictionary contains an entry for the PTToolManagerPageNumberUserInfoKey key with the added page number.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolManagerPageAddedNotification
Swift

static let PTToolManagerPageAdded: NSNotification.Name
PTToolManagerPageMovedNotification
Posted when a page is moved in the document.

The notification object is the tool manager that posted the notification. The userInfo dictionary contains entries for the PTToolManagerPreviousPageNumberUserInfoKey and PTToolManagerPageNumberUserInfoKey keys with the old and new page numbers, respectively.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolManagerPageMovedNotification
Swift

static let PTToolManagerPageMoved: NSNotification.Name
PTToolManagerPageRemovedNotification
Posted when a page is removed from the document.

The notification object is the tool manager that posted the notification. The userInfo dictionary contains an entry for the PTToolManagerPageNumberUserInfoKey key with the removed page number.
See more
Declaration
Objective-C

extern const NSNotificationName _Nonnull PTToolManagerPageRemovedNotification
Swift

static let PTToolManagerPageRemoved: NSNotification.Name

User Info Keys


                    
                    
                    PTToolManagerToolUserInfoKey

The key for a PTTool object.

Declaration

Objective-C

extern NSString *const _Nonnull PTToolManagerToolUserInfoKey

Swift

let PTToolManagerToolUserInfoKey: String


                    
                    
                    PTToolManagerPreviousPageNumberUserInfoKey

The key for a NSNumber object containing an int page number.

Declaration

Objective-C

extern NSString *const _Nonnull PTToolManagerPreviousPageNumberUserInfoKey

Swift

let PTToolManagerPreviousPageNumberUserInfoKey: String


                    
                    
                    PTToolsSettingsCategoryKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsCategoryKey

Swift

let PTToolsSettingsCategoryKey: String


                    
                    
                    PTToolsSettingsFooterDescriptionKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsFooterDescriptionKey

Swift

let PTToolsSettingsFooterDescriptionKey: String


                    
                    
                    PTToolsSettingsSettingKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsSettingKey

Swift

let PTToolsSettingsSettingKey: String


                    
                    
                    PTToolsSettingsMultivalueKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString*  const PTToolsSettingsMultivalueKey

Swift

let PTToolsSettingsMultivalueKey: String


                    
                    
                    PTToolsSettingsCategoryDefaultValueKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsCategoryDefaultValueKey

Swift

let PTToolsSettingsCategoryDefaultValueKey: String


                    
                    
                    PTToolsSettingsSettingNameKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsSettingNameKey

Swift

let PTToolsSettingsSettingNameKey: String


                    
                    
                    PTToolsSettingsCategoryDescriptionKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsCategoryDescriptionKey

Swift

let PTToolsSettingsCategoryDescriptionKey: String


                    
                    
                    PTToolsSettingsSettingKeyKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsSettingKeyKey

Swift

let PTToolsSettingsSettingKeyKey: String


                    
                    
                    PTToolsSettingsPlistNameKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsPlistNameKey

Swift

let PTToolsSettingsPlistNameKey: String


                    
                    
                    PTToolsSettingsMinOSKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsMinOSKey

Swift

let PTToolsSettingsMinOSKey: String


                    
                    
                    PTToolsSettingsUnavailableKey

Undocumented

Declaration

Objective-C

PT_EXPORT NSString * const PTToolsSettingsUnavailableKey

Swift

let PTToolsSettingsUnavailableKey: String