pdftron::PDF::Annots::Underline Class Reference

An Underline annotation shows as a line segment across the bottom of a word or a group of contiguous words. More...

#include <Underline.h>

Inheritance diagram for pdftron::PDF::Annots::Underline:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Static Public Member Functions

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


Detailed Description

An Underline annotation shows as a line segment across the bottom of a word or a group of contiguous words.

Constructor & Destructor Documentation

pdftron::PDF::Annots::Underline::Underline ( SDF::Obj  d  ) 

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

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

Creates a new Underline annotation in the specified document.

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


© 2002-2010 PDFTron Systems Inc.