PSPDFUserInterfaceControls

Objective-C

@protocol PSPDFUserInterfaceControls <NSObject>

Swift

protocol UserInterfaceControls : NSObjectProtocol

Protocol handling the user interface.

  • Defines if the user interface should be shown.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL shouldShowControls;

    Swift

    var shouldShowControls: Bool { get }

  • Hides the user interface.

    Declaration

    Objective-C

    - (BOOL)hideControlsAnimated:(BOOL)animated;

    Swift

    func hide(animated: Bool) -> Bool

  • Hides the user interface and additional elements like page selection.

    Declaration

    Objective-C

    - (BOOL)hideControlsAndPageElementsAnimated:(BOOL)animated;

    Swift

    func hideAndPageElements(animated: Bool) -> Bool

  • Toggles the visibility state of the user interface.

    Declaration

    Objective-C

    - (BOOL)toggleControlsAnimated:(BOOL)animated;

    Swift

    func toggle(animated: Bool) -> Bool

  • Shows the user interface.

    Declaration

    Objective-C

    - (BOOL)showControlsAnimated:(BOOL)animated;

    Swift

    func show(animated: Bool) -> Bool

  • Deprecated

    Deprecated in PSPDFKit 12.3 for iOS. Use one of the ‘PDFPageView.select(…:presentMenu:animated:)’ methods instead.

    Attempt to present a legacy menu for currently selected annotations, glyphs or image. If nothing is selected, calling this method does nothing.

    Warning

    This method is deprecated. To present the menu for selected annotations, use the PSPDFPageView/selectAnnotations:presentMenu:animated: method. To programmatically present the menu for selected glyphs, use the PSPDFPageView/selectGlyphs:presentMenu:animated: method. To present the menu for a selected image, use the PSPDFPageView/selectImage:presentMenu:animated: method.

    Declaration

    Objective-C

    - (void)showMenuIfSelectedWithOption:(PSPDFContextMenuOption)contextMenuOption
                            animated:(BOOL)animated;

    Swift

    func showMenuIfSelected(with contextMenuOption: ContextMenuOption, animated: Bool)