![]() |
#include <Caret.h>
Public Member Functions | |
Caret (SDF::Obj d=0) | |
Creates an Caret annotation and initializes it using given Cos/SDF object. | |
Caret (const Annot &ann) | |
Creates an Caret annotation and initializes it using given annotation object. | |
const char * | GetSymbol () const |
Returns the paragraph symbol associated with the caret. | |
void | SetSymbol (const char *symbol) |
Sets the caret symbol. | |
Static Public Member Functions | |
static Caret | Create (SDF::SDFDoc &doc, const Rect &pos) |
Creates a new Caret annotation in the specified document. | |
static Caret | Create (SDF::SDFDoc &doc, const Rect &pos, Rect padding) |
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. |
pdftron::PDF::Annots::Caret::Caret | ( | SDF::Obj | d = 0 |
) |
Creates an Caret annotation and initializes it using given Cos/SDF object.
pdftron::PDF::Annots::Caret::Caret | ( | const Annot & | ann | ) | [inline] |
Creates an Caret annotation and initializes it using given annotation object.
static Caret pdftron::PDF::Annots::Caret::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos | |||
) | [static] |
static Caret pdftron::PDF::Annots::Caret::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos, | |||
Rect | padding | |||
) | [static] |
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.
doc | A document to which the Caret annotation is added. | |
pos | A rectangle specifying the Caret annotation's bounds in default user space units. | |
diff | 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. |
const char* pdftron::PDF::Annots::Caret::GetSymbol | ( | ) | const |
Returns the paragraph symbol associated with the caret.
void pdftron::PDF::Annots::Caret::SetSymbol | ( | const char * | symbol | ) |
Sets the caret symbol.
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. |