pdftron::PDF::Annots::Popup Class Reference

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. More...

#include <Popup.h>

Inheritance diagram for pdftron::PDF::Annots::Popup:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Popup (SDF::Obj d=0)
 Creates a Popup annotation and initializes it using given Cos/SDF object.
 Popup (const Annot &ann)
 Creates a Popup annotation and initializes it using given annotation object.
Annot GetParent () const
 Returns the parent annotation of the Popup annotation.
void SetParent (const Annot &parent)
 Sets the Parent annotation of the Popup annotation.
bool IsOpen () const
 Returns the initial opening condition of Popup.
void SetOpen (bool is_open)
 Sets the initial opening condition of Popup.

Static Public Member Functions

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


Detailed Description

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing.

It shall not appear alone but is associated with a markup annotation, its parent annotation, and shall be used for editing the parent’s text. It shall have no appearance stream or associated actions of its own and shall be identified by the Popup entry in the parent’s annotation dictionary.


Constructor & Destructor Documentation

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

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

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

Creates a new Popup annotation in the specified document.

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

Annot pdftron::PDF::Annots::Popup::GetParent (  )  const

Returns the parent annotation of the Popup annotation.

Returns:
An annot object which is the parent annotation of the Popup annotation.
Note:
This annotation object represents the parent annotation with which this pop-up annotation shall be associated.

If this entry is present, the parent annotation’s Contents, M, C, and T entries shall override those of the pop-up annotation itself.

void pdftron::PDF::Annots::Popup::SetParent ( const Annot parent  ) 

Sets the Parent annotation of the Popup annotation.

(Optional)

Parameters:
parent An annot object which is the parent annotation of the Popup annotation.
Note:
This annotation object represents the parent annotation with which this pop-up annotation shall be associated.

If this entry is present, the parent annotation’s Contents, M, C, and T entries shall override those of the pop-up annotation itself.

bool pdftron::PDF::Annots::Popup::IsOpen (  )  const

Returns the initial opening condition of Popup.

Returns:
A bool indicating whether the Popup is initially open.
Note:
This is a flag specifying whether the pop-up annotation's window shall initially be displayed. Default value: false (closed).

void pdftron::PDF::Annots::Popup::SetOpen ( bool  is_open  ) 

Sets the initial opening condition of Popup.

(Optional)

Parameters:
is_open A bool indicating whether the Popup is initially open.
Note:
This is a flag specifying whether the pop-up annotation's window shall initially be displayed. Default value: false (closed).


© 2002-2010 PDFTron Systems Inc.