PSPDFGalleryViewController

Objective-C


@interface PSPDFGalleryViewController
    : PSPDFBaseViewController <PSPDFOverridable, PSPDFMultimediaViewController>

Swift

class GalleryViewController : PDFBaseViewController, Overridable, MultimediaViewController

Handles a gallery of one or multiple images, videos, audio or even web content.

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_DEFAULT_VIEWCONTROLLER_INIT_UNAVAILABLE
  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_DEFAULT_VIEWCONTROLLER_INIT_UNAVAILABLE
  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_DEFAULT_VIEWCONTROLLER_INIT_UNAVAILABLE
  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_DEFAULT_VIEWCONTROLLER_INIT_UNAVAILABLE
  • Create a new gallery view controller by passing in a link annotation.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLinkAnnotation:
        (nonnull PSPDFLinkAnnotation *)linkAnnotation;

    Swift

    init(linkAnnotation: PSPDFLinkAnnotation)
  • The configuration. Defaults to +[PSPDFGalleryConfiguration defaultConfiguration].

    Declaration

    Objective-C

    @property (nonatomic) PSPDFGalleryConfiguration *_Nonnull configuration;

    Swift

    var configuration: PSPDFGalleryConfiguration { get set }
  • The current state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFGalleryViewControllerState state;

    Swift

    var state: GalleryViewController.State { get }
  • All items of this gallery. Only set if state is PSPDFGalleryViewControllerStateReady.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<__kindof PSPDFGalleryItem *> *items;

    Swift

    var items: [GalleryItem]? { get }
  • The link annotation that was used to instantiate the view controller.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFLinkAnnotation *_Nonnull linkAnnotation;

    Swift

    var linkAnnotation: PSPDFLinkAnnotation { get }
  • Used to enter or exit the fullscreen mode.

    See

    setFullscreen:animated:.

    Declaration

    Objective-C

    @property (nonatomic, getter=isFullscreen) BOOL fullscreen;

    Swift

    var isFullscreen: Bool { get set }
  • Specifies whether the receiver is visible. In regular operation, this will be set by its owner. There are cases where-in you might want to alter behavior based on the receiver’s visibility.

    Declaration

    Objective-C

    @property (nonatomic, getter=isVisible) BOOL visible;

    Swift

    var isVisible: Bool { get set }
  • Used to enter or exit the fullscreen mode with or without animation. The transition is only initiated, if all gallery items support fullscreen presentation.

    Warning

    If you use this property programmatically, you must set it to false once you’re done with your instance of PSPDFGalleryViewController!

    Declaration

    Objective-C

    - (void)setFullscreen:(BOOL)fullscreen animated:(BOOL)animated;

    Swift

    func setFullscreen(_ fullscreen: Bool, animated: Bool)
  • The current zoom scale. Only valid when displayed as an embedded gallery within a PDF document. Defaults to 1.0.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat zoomScale;

    Swift

    var zoomScale: CGFloat { get set }
  • Single-Tap: Show/Hide image description.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UITapGestureRecognizer *_Nonnull singleTapGestureRecognizer;

    Swift

    var singleTapGestureRecognizer: UITapGestureRecognizer { get }
  • Double-Tap: Toggle Full-Screen.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UITapGestureRecognizer *_Nonnull doubleTapGestureRecognizer;

    Swift

    var doubleTapGestureRecognizer: UITapGestureRecognizer { get }
  • Pan: Dismiss Full-Screen mode.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UIPanGestureRecognizer *_Nonnull panGestureRecognizer;

    Swift

    var panGestureRecognizer: UIPanGestureRecognizer { get }