PTCaret

@interface PTCaret : PTMarkup

A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

  • Creates an Caret annotation and initializes it using given Cos/SDF object.

    Note

    The constructor does not copy any data, but is instead the logical equivalent of a type cast.

    Declaration

    Objective-C

    - (instancetype)initWithD:(PTObj *)d;

    Swift

    init!(d: PTObj!)

    Parameters

    d

    The Cos/SDF object to initialze the annotation with.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithAnn: (PTAnnot*)ann;

    Swift

    init!(ann: PTAnnot!)

  • Creates a new Caret annotation in the specified document.

    Declaration

    Objective-C

    + (PTCaret *)Create:(PTSDFDoc *)doc pos:(PTPDFRect *)pos;

    Swift

    class func create(_ doc: PTSDFDoc!, pos: PTPDFRect!) -> PTCaret!

    Parameters

    doc

    A document to which the Caret annotation is added.
    pos

    A rectangle specifying the Caret annotation’s bounds in default user space units.

    Return Value

    A newly created blank Caret annotation.

  • Creates a new Caret annotation, in the specified document, specifying a set of four numbers that shall describe the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying Caret.

    Declaration

    Objective-C

    + (PTCaret *)CreateAnnot:(PTSDFDoc *)doc pos:(PTPDFRect *)pos;

    Swift

    class func createAnnot(_ doc: PTSDFDoc!, pos: PTPDFRect!) -> PTCaret!

    Parameters

    doc

    A document to which the Caret annotation is added.
    pos

    A rectangle specifying the Caret annotation’s bounds in default user space units.
    padding

    A set of four numbers(represented as a Rect object)specifying the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying Caret.

    Return Value

    A newly created Caret annotation with rectangle difference specified.

  • Undocumented

    Declaration

    Objective-C

    + (PTCaret*)CreateWithPadding: (PTSDFDoc*)doc pos:  (PTPDFRect*)pos padding:  (PTPDFRect*)padding;

    Swift

    class func create(withPadding doc: PTSDFDoc!, pos: PTPDFRect!, padding: PTPDFRect!) -> PTCaret!

  • Returns the paragraph symbol associated with the caret.

    Declaration

    Objective-C

    - (NSString *)GetSymbol;

    Swift

    func getSymbol() -> String!

    Return Value

    The name of the symbol. This can be either “P” (Use a new paragraph symbol) or “None” (Don’t use any symbol). Default value: None.

  • Sets the caret symbol.

    Declaration

    Objective-C

    - (void)SetSymbol:(NSString *)symbol;

    Swift

    func setSymbol(_ symbol: String!)

    Parameters

    symbol

    The name of the symbol. This can be either “P” (Use a new paragraph symbol) or “None” (Don’t use any symbol). Default value: None.