PTToolOptionsDelegate

@protocol PTToolOptionsDelegate <NSObject>

The PTToolOptionsDelegate protocol allows the adopting class to provide annotation options information to a tool.

  • Used by a tool to check whether the specified annotation type can be created.

    Declaration

    Objective-C

    - (BOOL)tool:(nonnull PTTool *)tool
    canCreateExtendedAnnotType:(PTExtendedAnnotType)annotType;

    Swift

    func tool(_ tool: PTTool, canCreateExtendedAnnotType annotType: PTExtendedAnnotType) -> Bool

    Parameters

    tool

    the tool that sent the message
    annotType

    the annotation type to be created

    Return Value

    YES if the annotation type can be created, NO otherwise

  • Used by a tool to check whether the specified annotation can be edited.

    Declaration

    Objective-C

    - (BOOL)tool:(nonnull PTTool *)tool
    canEditAnnotation:(nonnull PTAnnot *)annotation;

    Swift

    func tool(_ tool: PTTool, canEditAnnotation annotation: PTAnnot) -> Bool

    Parameters

    tool

    the tool that sent the message
    annotation

    the annotation to be edited

    Return Value

    YES if the annotation can be edited, NO otherwise

  • Used by a tool to check whether the specified annotation type can be edited.

    Declaration

    Objective-C

    - (BOOL)tool:(nonnull PTTool *)tool
    canEditExtendedAnnotType:(PTExtendedAnnotType)annotType;

    Swift

    func tool(_ tool: PTTool, canEdit annotType: PTExtendedAnnotType) -> Bool

    Parameters

    tool

    the tool that sent the message
    annotType

    the annotation type to be edited

    Return Value

    YES if the annotation type can be edited, NO otherwise

Annotation permissions

  • Used by a tool to check whether the specified annotation allows editing.

    Declaration

    Objective-C

    - (BOOL)tool:(nonnull PTTool *)tool
    hasEditPermissionForAnnot:(nonnull PTAnnot *)annot;

    Swift

    func tool(_ tool: PTTool, hasEditPermissionFor annot: PTAnnot) -> Bool

    Parameters

    tool

    the tool that sent the message.
    annot

    the annotation to be edited

    Return Value

    YES if the annotation allows editing, NO otherwise

Convenience

  • Used by a tool to check if text selection is enabled.

    Declaration

    Objective-C

    - (BOOL)isTextSelectionEnabledForTool:(nonnull PTTool *)tool;

    Swift

    func isTextSelectionEnabled(for tool: PTTool) -> Bool

  • Used by a tool to check if form filling is enabled.

    Declaration

    Objective-C

    - (BOOL)isFormFillingEnabledForTool:(nonnull PTTool *)tool;

    Swift

    func isFormFillingEnabled(for tool: PTTool) -> Bool

  • Used by a tool to check if link following is enabled.

    Declaration

    Objective-C

    - (BOOL)isLinkFollowingEnabledForTool:(nonnull PTTool *)tool;

    Swift

    func isLinkFollowingEnabled(for tool: PTTool) -> Bool

  • Used by a tool to check if the eraser tool is enabled.

    Declaration

    Objective-C

    - (BOOL)isEraserEnabledForTool:(nonnull PTTool *)tool;

    Swift

    func isEraserEnabled(for tool: PTTool) -> Bool

  • Used to check if auto resizing free text is enabled.

    Declaration

    Objective-C

    - (BOOL)autoResizeFreeText;

    Swift

    func autoResizeFreeText() -> Bool

  • Used to set if auto resizing free text is enabled.

    Declaration

    Objective-C

    - (void)setAutoResizeFreeText:(BOOL)enabled;

    Swift

    func setAutoResizeFreeText(_ enabled: Bool)

  • Used to check if snapping to document geometry is enabled.

    Declaration

    Objective-C

    - (BOOL)snapToDocumentGeometry;

    Swift

    func snapToDocumentGeometry() -> Bool

  • Used to set if snapping to document geometry is enabled.

    Declaration

    Objective-C

    - (void)setSnapToDocumentGeometry:(BOOL)enabled;

    Swift

    func setSnapToDocumentGeometry(_ enabled: Bool)