PTDocumentController


@interface PTDocumentController
    : PTDocumentBaseViewController <PTOverridable, PTToolGroupManagerDelegate,
                                    PTToolGroupToolbarDelegate>

A view controller that displays a PTPDFViewCtrl along with other controls.

Tool groups

  • Whether tool groups are enabled in this view controller. This property controls whether the toolGroupToolbar is shown.

    The default value of this property is YES.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=areToolGroupsEnabled) BOOL toolGroupsEnabled;

    Swift

    var areToolGroupsEnabled: Bool { get set }

  • The tool group manager instance used to control the current tool group and the set of bar button items displayed in the tool group toolbar.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) PTToolGroupManager *_Nonnull toolGroupManager;

    Swift

    var toolGroupManager: PTToolGroupManager { get }

Tool group toolbar

  • The tool group toolbar used by this class when the areToolGroupsEnabled property is enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) PTToolGroupToolbar *_Nonnull toolGroupToolbar;

    Swift

    var toolGroupToolbar: PTToolGroupToolbar { get }

  • Whether the isToolGroupToolbarHidden property of this view controller is updated as part of its bar-hiding (and -showing) behavior.

    When enabled, the isToolGroupToolbarHidden property will be updated by the controlsHidden property in response to handled taps, automatically based on a timer, and other logic. Otherwise, the isToolGroupToolbarHidden property will not be updated and it is the responsibility of users of this class to ensure that the bars are consistent with the desired behavior and appearance.

    The default value of this property is YES.

    See

    isToolGroupToolbarHidden

    Declaration

    Objective-C

    @property (nonatomic) BOOL hidesToolGroupToolbar;

    Swift

    var hidesToolGroupToolbar: Bool { get set }

  • Whether the tool group toolbar is hidden.

    The default value of this property is YES.

    See

    -setToolGroupToolbarHidden:animated:

    See

    hidesToolGroupToolbar

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isToolGroupToolbarHidden) BOOL toolGroupToolbarHidden;

    Swift

    var isToolGroupToolbarHidden: Bool { get set }

  • Sets whether the tool group toolbar is hidden.

    See

    isToolGroupToolbarHidden

    Declaration

    Objective-C

    - (void)setToolGroupToolbarHidden:(BOOL)hidden animated:(BOOL)animated;

    Swift

    func setToolGroupToolbarHidden(_ hidden: Bool, animated: Bool)

    Parameters

    hidden

    Specify YES to hide the tool group toolbar or NO to show it.
    animated

    Specify YES if you want to animate the change in visibility or NO if you want the control to appear immediately.

Tool group accessory views

Tool group view controllers

UINavigationItem

Bar button items

  • When this view controller is contained in a PTTabbedDocumentViewController instance, shows all the tabbed document view controller’s document tabs.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) UIBarButtonItem *_Nonnull tabsButtonItem;

    Swift

    var tabsButtonItem: UIBarButtonItem { get }

  • Whether the tabsButtonItem should be automatically shown when this view controller is contained in a PTTabbedDocumentViewController.

    The default value of this property is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL automaticallyShowsTabsButton;

    Swift

    var automaticallyShowsTabsButton: Bool { get set }

Document slider