HYPSnapshotPluginModule

@interface HYPSnapshotPluginModule
    : HYPPluginModule <HYPSnapshotPluginViewProvider>

HYPSnapshotPluginModule is a base implementation of a Snapshot Plugin.

  • The title that should display for the plugin menu Item.

    Declaration

    Objective-C

    - (nonnull NSString *)pluginMenuItemTitle;

    Swift

    func pluginMenuItemTitle() -> String

    Return Value

    The title that should display for the plugin menu Item.

    Show on GitHub

  • The image that should display for the plugin menu Item.

    Declaration

    Objective-C

    - (id)pluginMenuItemImage;

    Swift

    func pluginMenuItemImage() -> Any!

    Return Value

    The image that should display for the plugin menu Item.

    Show on GitHub

  • Determines whether the drawer should hide when the plugin becomes active/inactive.

    Declaration

    Objective-C

    - (BOOL)shouldHideDrawerOnSelection;

    Swift

    func shouldHideDrawerOnSelection() -> Bool

    Return Value

    Yes if the drawer should hide when the plugin becomes active/inactive.

    Show on GitHub

  • The view that should get added the Snap Shot container when activated.

    Declaration

    Objective-C

    @property (readonly, nonatomic) int *_Nullable snapshotPluginView;

    Swift

    var snapshotPluginView: UnsafeMutablePointer

    Return Value

    The view that should get added the Snap Shot container when activated.

    Show on GitHub