pdftron::PDF::Annots::Caret Class Reference

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

#include <Caret.h>

Inheritance diagram for pdftron::PDF::Annots::Caret:

[legend]

Collaboration diagram for pdftron::PDF::Annots::Caret:

[legend]

List of all members.

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.

---

Detailed Description

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

---

Constructor & Destructor Documentation

pdftron::PDF::Annots::Caret::Caret

(

SDF::Obj

d = 0

)

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.

pdftron::PDF::Annots::Caret::Caret

(

const Annot &

ann

)

[inline]

Creates an Caret annotation and initializes it using given annotation object.

Note:

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

---

Member Function Documentation

static Caret pdftron::PDF::Annots::Caret::Create	(	SDF::SDFDoc &	doc,
		const Rect &	pos
	)			[static]

Creates a new Caret annotation in the specified document.

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.

Returns:

A newly created blank Caret annotation.

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.

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.
	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.

Returns:

A newly created Caret annotation with rectangle difference specified.

const char* pdftron::PDF::Annots::Caret::GetSymbol

(

)

const

Returns the paragraph symbol associated with the caret.

Returns:

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.

void pdftron::PDF::Annots::Caret::SetSymbol

(

const char *

symbol

)

Sets the caret symbol.

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.