pdftron::PDF::Annots::Square Class Reference

Square annotation is used to display a rectangle on the page. More...

#include <Square.h>

Inheritance diagram for pdftron::PDF::Annots::Square:

[legend]

Collaboration diagram for pdftron::PDF::Annots::Square:

[legend]

List of all members.

Public Member Functions
	Square (SDF::Obj d=0)
	Creates an Square annotation and initializes it using given Cos/SDF object.
	Square (const Annot &ann)
	Creates a Square annotation and initializes it using given annotation object.
Static Public Member Functions
static Square	Create (SDF::SDFDoc &doc, const Rect &pos)
	Creates a new Square annotation in the specified document.

---

Detailed Description

Square annotation is used to display a rectangle on the page.

When opened, a square annotation can display a pop-up window containing the text of the associated note. The rectangle may be inscribed and possibly padded within the annotation rectangle defined by the annotation dictionary's Rect entry.

---

Constructor & Destructor Documentation

pdftron::PDF::Annots::Square::Square

(

SDF::Obj

d = 0

)

Creates an Square 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::Square::Square

(

const Annot &

ann

)

[inline]

Creates a Square 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 Square pdftron::PDF::Annots::Square::Create	(	SDF::SDFDoc &	doc,
		const Rect &	pos
	)			[static]

Creates a new Square annotation in the specified document.

Parameters:

	doc	A document to which the annotation is added.
	pos	A rectangle specifying the annotation's bounds, in user space coordinates.

Returns:

A newly created blank Square annotation.