PSPDFViewControllerDelegate

Objective-C

@protocol PSPDFViewControllerDelegate <NSObject>

Swift

protocol PDFViewControllerDelegate : NSObjectProtocol

Implement this delegate in your UIViewController to get notified of PDFViewController events.

Document Handling

  • Asks the delegate if the specified document should be saved with the provided options.

    Note

    This method will only be called if the view controller’s PSPDFConfiguration autosave option is set to YES, and its annotation save mode is set to a value other than PSPDFAnnotationSaveModeDisabled.

    Declaration

    Objective-C

    - (BOOL)pdfViewController:(nonnull PSPDFViewController *)pdfController
       shouldSaveDocument:(nonnull PSPDFDocument *)document
              withOptions:(NSDictionary<PSPDFDocumentSaveOption, id> *_Nonnull
                               *_Nonnull)options;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, shouldSave document: Document, withOptions options: AutoreleasingUnsafeMutablePointer<NSDictionary>) -> Bool

    Parameters

    pdfController

    The PSPDFViewController instance.
    document

    The document to save.
    options

    The current options that the document is going to be saved with. This is an inout parameter.

    Return Value

    BOOL indicating whether the passed document should be saved with the passed parameters.

  • Notifies the delegate that the specified document’s saving operation was completed.

    Note

    This method will only be called if the view controller’s PSPDFConfiguration autosave option is set to YES, and its annotation save mode is set to a value other than PSPDFAnnotationSaveModeDisabled.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
          didSaveDocument:(nonnull PSPDFDocument *)document
                    error:(nullable NSError *)error;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didSave document: Document, error: Error?)

    Parameters

    pdfController

    The PSPDFViewController instance.
    document

    The document that was saved.
    error

    The error that occurred during document saving, if any. Can be nil.

  • Will be called when an action tries to change the document (For example, a PDF link annotation pointing to another document). Will also be called when the document is changed via using the document property. Return NO to block changing the document.

    Declaration

    Objective-C

    - (BOOL)pdfViewController:(nonnull PSPDFViewController *)pdfController
     shouldChangeDocument:(nullable PSPDFDocument *)document;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, shouldChange document: Document?) -> Bool

  • Will be called after the document has been changed.

    Note

    This will also be called for nil and broken documents. use document.isValid to check.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
        didChangeDocument:(nullable PSPDFDocument *)document;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didChange document: Document?)

Scroll and Page Events

  • Called when a page view schedules a render task to update its content view.

    Once the render tasks completes, pdfViewController:didFinishRenderTaskForPageView: will be called.

    See

    pdfViewController:didFinishRenderTaskForPageView:

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
    willScheduleRenderTaskForPageView:(nonnull PSPDFPageView *)pageView;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, willScheduleRenderTaskFor pageView: PSPDFPageView)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that scheduled the render task.

  • Called when a render task finishes that was scheduled by a page view to update its content view.

    See

    pdfViewController:willScheduleRenderTaskForPageView:

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
    didFinishRenderTaskForPageView:(nonnull PSPDFPageView *)pageView;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didFinishRenderTaskFor pageView: PSPDFPageView)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that scheduled the render task.

  • Called when a page view sets an image on its content view. This image can either be a full sized image, a smaller image that is used while waiting for a full sized image, or nil. The image might be acquired from the cache or from a render task.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
    didUpdateContentImageForPageView:(nonnull PSPDFPageView *)pageView
                       isPlaceholder:(BOOL)placeholder;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didUpdateContentImageFor pageView: PSPDFPageView, isPlaceholder placeholder: Bool)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that updated its content view’s image.
    placeholder

    YES if the image set in the content view is just a placeholder while waiting for a full resolution image from the render engine. The placeholder image might also be nil.

  • Called before a page view enters the visible screen area.

    You can use this method to customize the page view before it is displayed. Say, for example, you’ve built a custom user interface for searching, you can use this method to add the search highlights to the page before it comes on screen.

    This call is bound to the page view’s spread view and will be triggered before the spread view enters the visible screen area. As such, you should generally avoid to begin view animations on the page in this callback: CoreAnimation may skip the animation of off-screen elements. If you want to animate changes to the page’s view hierarchy, have a look at PSPDFDocumentViewControllerSpreadIndexDidChangeNotification instead.

    This call will not be invoked for page views belonging to spreads that have an active first responder. This matches the behavior of similar UICollectionViewDelegate callbacks.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
    willBeginDisplayingPageView:(nonnull PSPDFPageView *)pageView
                 forPageAtIndex:(NSInteger)pageIndex;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, willBeginDisplaying pageView: PSPDFPageView, forPageAt pageIndex: Int)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that is about to enter the visible screen.
    pageIndex

    The page index of the page that this page view will display.

  • Called when a page view exits the visible screen area.

    This call is bound to the page view’s spread view and will be triggered when the spread view leaves the visible screen area.

    This call will not be invoked for page views belonging to spreads that have an active first responder. This matches the behavior of similar UICollectionViewDelegate callbacks.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
    didEndDisplayingPageView:(nonnull PSPDFPageView *)pageView
              forPageAtIndex:(NSInteger)pageIndex;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didEndDisplaying pageView: PSPDFPageView, forPageAt pageIndex: Int)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that exits the visible screen.
    pageIndex

    The page index of the page that this page view has displayed.

  • Called when a page view is configured for the view hierarchy.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
     didConfigurePageView:(nonnull PSPDFPageView *)pageView
           forPageAtIndex:(NSInteger)pageIndex;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didConfigurePageView pageView: PSPDFPageView, forPageAt pageIndex: Int)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that is configured for the view hierarchy.
    pageIndex

    The page index of the page that this page view will display.

  • Called when a page view is cleaned up from the view hierarchy.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
       didCleanupPageView:(nonnull PSPDFPageView *)pageView
           forPageAtIndex:(NSInteger)pageIndex;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didCleanupPageView pageView: PSPDFPageView, forPageAt pageIndex: Int)

    Parameters

    pdfController

    The pdf view controller the page view belongs to.
    pageView

    The page view that is removed from the view hierarchy.
    pageIndex

    The page index of the page that this page view has displayed.

  • Return a PSPDFDocument for a relative path. If this returns nil, we try to find the PDF ourselves with using the current document’s basePath.

    Declaration

    Objective-C

    - (nullable PSPDFDocument *)pdfViewController:
                                (nonnull PSPDFViewController *)pdfController
                      documentForRelativePath:(nonnull NSString *)relativePath;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, documentForRelativePath relativePath: String) -> Document?

Text Selection

Menu Handling

Annotations

View Controller Management

  • Called before we show a internal controller (color picker, note editor, …) modally or in a popover. Allows last minute modifications.

    Return NO to process the displaying manually.

    Declaration

    Objective-C

    - (BOOL)pdfViewController:(nonnull PSPDFViewController *)pdfController
     shouldShowController:(nonnull UIViewController *)controller
                  options:(nullable NSDictionary<NSString *, id> *)options
                 animated:(BOOL)animated;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, shouldShow controller: UIViewController, options: [String : Any]? = nil, animated: Bool) -> Bool

  • Called after the controller has been fully displayed.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
        didShowController:(nonnull UIViewController *)controller
                  options:(nullable NSDictionary<NSString *, id> *)options
                 animated:(BOOL)animated;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didShow controller: UIViewController, options: [String : Any]? = nil, animated: Bool)

General View State

  • Will be called when viewMode changes.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
        didChangeViewMode:(PSPDFViewMode)viewMode;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didChange viewMode: ViewMode)

  • Called before the view controller will be dismissed (either by modal dismissal, or popping from the navigation stack). Called before PSPDFKit tries to save any dirty annotation.

    Note

    If you use child view containment then the dismissal might not be properly detected.

    Declaration

    Objective-C

    - (void)pdfViewControllerWillDismiss:
    (nonnull PSPDFViewController *)pdfController;

    Swift

    optional func pdfViewControllerWillDismiss(_ pdfController: PDFViewController)

  • Called after the view controller has been dismissed (either by modal dismissal, or popping from the navigation stack).

    Note

    If you use child view containment then the dismissal might not be properly detected.

    Declaration

    Objective-C

    - (void)pdfViewControllerDidDismiss:
    (nonnull PSPDFViewController *)pdfController;

    Swift

    optional func pdfViewControllerDidDismiss(_ pdfController: PDFViewController)

Display State

  • Called after the view controller changed its controller state or its controller state error.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
    didChangeControllerState:(PSPDFControllerState)controllerState
                       error:(nullable NSError *)error;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didChange controllerState: ControllerState, error: Error?)

    Parameters

    pdfController

    The controller that changed its state.
    controllerState

    The new state that the controller was changed to.
    error

    The underlying error if the controllerState provided is either .error or .locked.

user interface

Actions

  • Called every time before an action will be executed. Actions can come from many sources: Links, Forms, or any other annotation type (via additionalActions) Actions can be invoked on trigger events like PSPDFAnnotationTriggerEventMouseDown. Using the back/forward list will also trigger actions.

    Return NO to prevent the PDF action from being executed.

    Note

    This is also called for every sub-action the action has.

    Declaration

    Objective-C

    - (BOOL)pdfViewController:(nonnull PSPDFViewController *)pdfController
      shouldExecuteAction:(nonnull PSPDFAction *)action;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, shouldExecute action: Action) -> Bool

  • Called every time after an action has been executed.

    Note

    This is also called for every sub-action the action has.

    Declaration

    Objective-C

    - (void)pdfViewController:(nonnull PSPDFViewController *)pdfController
         didExecuteAction:(nonnull PSPDFAction *)action;

    Swift

    optional func pdfViewController(_ pdfController: PDFViewController, didExecute action: Action)

Deprecated API