pdftron::PDF::Annots::Circle Class Reference

A Circle annotation is a type of markup annotation that displays an ellipse on the page. More...

#include <Circle.h>

Inheritance diagram for pdftron::PDF::Annots::Circle:

Inheritance graph
[legend]
Collaboration diagram for pdftron::PDF::Annots::Circle:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Circle (SDF::Obj d=0)
 Creates an Circle annotation and initializes it using given Cos/SDF object.
 Circle (const Annot &ann)
 Creates a Circle annotation and initializes it using given annotation object.

Static Public Member Functions

static Circle Create (SDF::SDFDoc &doc, const Rect &pos)
 Creates a new Circle annotation in the specified document.


Detailed Description

A Circle annotation is a type of markup annotation that displays an ellipse on the page.

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


Constructor & Destructor Documentation

pdftron::PDF::Annots::Circle::Circle ( SDF::Obj  d = 0  ) 

Creates an Circle 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::Circle::Circle ( const Annot ann  )  [inline]

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

Creates a new Circle annotation in the specified document.

Parameters:
doc A document to which the annotation is added.
pos A rectangle specifying the annotation's bounds in default user space units.
Returns:
A newly created blank Circle annotation.


© 2002-2010 PDFTron Systems Inc.