PoDoFo::PdfAnnotation Class Reference
#include <PdfAnnotation.h>
List of all members.
Public Member Functions |
| PdfAnnotation (PdfPage *pPage, EPdfAnnotation eAnnot, const PdfRect &rRect, PdfVecObjects *pParent) |
| PdfAnnotation (PdfObject *pObject, PdfPage *pPage) |
void | SetAppearanceStream (PdfXObject *pObject) |
bool | HasAppearanceStream () const |
PdfRect | GetRect () const |
void | SetFlags (pdf_uint32 uiFlags) |
pdf_uint32 | GetFlags () const |
void | SetBorderStyle (double dHCorner, double dVCorner, double dWidth) |
void | SetBorderStyle (double dHCorner, double dVCorner, double dWidth, const PdfArray &rStrokeStyle) |
void | SetTitle (const PdfString &sTitle) |
PdfString | GetTitle () const |
void | SetContents (const PdfString &sContents) |
PdfString | GetContents () const |
void | SetDestination (const PdfDestination &rDestination) |
PdfDestination | GetDestination (PdfDocument *pDoc) const |
bool | HasDestination () const |
void | SetAction (const PdfAction &rAction) |
PdfAction * | GetAction () const |
bool | HasAction () const |
void | SetOpen (bool b) |
bool | GetOpen () const |
bool | HasFileAttachement () const |
void | SetFileAttachement (const PdfFileSpec &rFileSpec) |
PdfFileSpec * | GetFileAttachement () const |
PdfArray | GetQuadPoints () const |
void | SetQuadPoints (const PdfArray &rQuadPoints) |
PdfArray | GetColor () const |
void | SetColor (double r, double g, double b) |
void | SetColor (double c, double m, double y, double k) |
void | SetColor (double gray) |
void | SetColor () |
EPdfAnnotation | GetType () const |
PdfPage * | GetPage () const |
Detailed Description
An annotation to a PdfPage To create an annotation use PdfPage::CreateAnnotation
- See also:
- PdfPage::CreateAnnotation
Constructor & Destructor Documentation
Create a new annotation object
- Parameters:
-
| pPage | the parent page of this annotation |
| eAnnot | type of the annotation |
| rRect | the rectangle in which the annotation will appear on the page |
| pParent | parent of this annotation |
- See also:
- PdfPage::CreateAnnotation
Create a PdfAnnotation from an existing object
- Parameters:
-
| pObject | the annotations object |
| pPage | the page of the annotation |
Member Function Documentation
PdfAction * PoDoFo::PdfAnnotation::GetAction |
( |
|
) |
const |
Get the action that is executed for this annotation
- Returns:
- an action object. The action object is owned by the PdfAnnotation.
- See also:
- SetAction
PdfArray PoDoFo::PdfAnnotation::GetColor |
( |
|
) |
const |
Get the color key of the Annotation dictionary which defines the color of the annotation, as per 8.4 of the pdf spec. The PdfArray contains 0 to four numbers, depending on the colorspace in which the color is specified 0 numbers means the annotation is transparent 1 number specifies the intensity of the color in grayscale 3 numbers specifie the color in the RGB colorspace and 4 numbers specify the color in the CMYK colorspace
- Returns:
- a PdfArray of either 0, 1, 3 or 4 numbers depending on the colorspace in which the color is specified
PdfString PoDoFo::PdfAnnotation::GetContents |
( |
|
) |
const |
Get the text of this annotation
- Returns:
- the contents of this annotation
- See also:
- SetContents
Get the destination of a link annotations
- Parameters:
-
| pDoc | a PdfDocument owning this annotation. This is required to resolve names and pages. |
- Returns:
- a destination object
- See also:
- SetDestination
PdfFileSpec * PoDoFo::PdfAnnotation::GetFileAttachement |
( |
|
) |
const |
Get a file attachement of this annotation.
- Returns:
- a file specification object. The file specification object is owned by the PdfAnnotation.
- See also:
- SetFileAttachement
pdf_uint32 PoDoFo::PdfAnnotation::GetFlags |
( |
|
) |
const |
Get the flags of this annotation.
- Returns:
- the flags which is an unsigned 32bit integer with different EPdfAnnotationFlags OR'ed together.
- See also:
- SetFlags
bool PoDoFo::PdfAnnotation::GetOpen |
( |
|
) |
const |
- Returns:
- true if this annotation should be opened immediately by the viewer
PdfPage * PoDoFo::PdfAnnotation::GetPage |
( |
|
) |
const [inline] |
Get the page of this PdfField
- Returns:
- the page of this PdfField
PdfArray PoDoFo::PdfAnnotation::GetQuadPoints |
( |
|
) |
const |
Get the quad points associated with the annotation (if appropriate). This array is used in text markup annotations to describe the regions affected by the markup (i.e. the hilighted words, one quadrilateral per word)
- Returns:
- a PdfArray of 8xn numbers describing the x,y coordinates of BL BR TR TL corners of the quadrilaterals. If inappropriate, returns an empty array.
PdfRect PoDoFo::PdfAnnotation::GetRect |
( |
|
) |
const |
Get the rectangle of this annotation
- Returns:
- a rectangle
PdfString PoDoFo::PdfAnnotation::GetTitle |
( |
|
) |
const |
Get the title of this annotation
- Returns:
- the title of this annotation
- See also:
- SetTitle
Get the type of this annotation
- Returns:
- the annotation type
bool PoDoFo::PdfAnnotation::HasAction |
( |
|
) |
const |
- Returns:
- true if this annotation has an action
bool PoDoFo::PdfAnnotation::HasAppearanceStream |
( |
|
) |
const |
- Returns:
- true if this annotation has an appearance stream
bool PoDoFo::PdfAnnotation::HasDestination |
( |
|
) |
const |
- Returns:
- true if this annotation has an destination
bool PoDoFo::PdfAnnotation::HasFileAttachement |
( |
|
) |
const |
- Returns:
- true if this annotation has a file attachement
void PoDoFo::PdfAnnotation::SetAction |
( |
const PdfAction & |
rAction |
) |
|
Set the action that is executed for this annotation
- Parameters:
-
- See also:
- GetAction
void PoDoFo::PdfAnnotation::SetAppearanceStream |
( |
PdfXObject * |
pObject |
) |
|
Set an appearance stream for this object to specify its visual appearance
- Parameters:
-
void PoDoFo::PdfAnnotation::SetBorderStyle |
( |
double |
dHCorner, |
|
|
double |
dVCorner, |
|
|
double |
dWidth, |
|
|
const PdfArray & |
rStrokeStyle | |
|
) |
| | |
Set the annotations border style.
- Parameters:
-
| dHCorner | horitzontal corner radius |
| dVCorner | vertical corner radius |
| dWidth | width of border |
| rStrokeStyle | a custom stroke style pattern |
void PoDoFo::PdfAnnotation::SetBorderStyle |
( |
double |
dHCorner, |
|
|
double |
dVCorner, |
|
|
double |
dWidth | |
|
) |
| | |
Set the annotations border style.
- Parameters:
-
| dHCorner | horitzontal corner radius |
| dVCorner | vertical corner radius |
| dWidth | width of border |
void PoDoFo::PdfAnnotation::SetColor |
( |
|
) |
|
Set the C key of the Annotation dictionary to an empty array, which, as per 8.4 of the pdf spec., makes the annotation transparent
void PoDoFo::PdfAnnotation::SetColor |
( |
double |
gray |
) |
|
Set the C key of the Annotation dictionary, which defines the color of the annotation, as per 8.4 of the pdf spec. Parameters give the color in grayscale colorspace coordinates
- Parameters:
-
| gray | number from 0 to 1, the intensity of the black |
void PoDoFo::PdfAnnotation::SetColor |
( |
double |
c, |
|
|
double |
m, |
|
|
double |
y, |
|
|
double |
k | |
|
) |
| | |
Set the C key of the Annotation dictionary, which defines the color of the annotation, as per 8.4 of the pdf spec. Parameters give the color in cmyk colorspace coordinates
- Parameters:
-
| c | number from 0 to 1, the intensity of the cyan channel |
| m | number from 0 to 1, the intensity of the magneta channel |
| y | number from 0 to 1, the intensity of the yellow channel |
| k | number from 0 to 1, the intensity of the black channel |
void PoDoFo::PdfAnnotation::SetColor |
( |
double |
r, |
|
|
double |
g, |
|
|
double |
b | |
|
) |
| | |
Set the C key of the Annotation dictionary, which defines the color of the annotation, as per 8.4 of the pdf spec. Parameters give the color in rgb colorspace coordinates
- Parameters:
-
| r | number from 0 to 1, the intensity of the red channel |
| g | number from 0 to 1, the intensity of the green channel |
| b | number from 0 to 1, the intensity of the blue channel |
void PoDoFo::PdfAnnotation::SetContents |
( |
const PdfString & |
sContents |
) |
|
Set the text of this annotation.
- Parameters:
-
| sContents | text of the annoation as string in PDF format |
- See also:
- GetContents
void PoDoFo::PdfAnnotation::SetDestination |
( |
const PdfDestination & |
rDestination |
) |
|
Set the destination for link annotations
- Parameters:
-
| rDestination | target of the link |
- See also:
- GetDestination
void PoDoFo::PdfAnnotation::SetFileAttachement |
( |
const PdfFileSpec & |
rFileSpec |
) |
|
Set a file attachment for this annotation. The type of this annotation has to be ePdfAnnotation_FileAttachement for file attachements to work.
- Parameters:
-
| rFileSpec | a file specification |
void PoDoFo::PdfAnnotation::SetFlags |
( |
pdf_uint32 |
uiFlags |
) |
|
Set the flags of this annotation.
- Parameters:
-
| uiFlags | is an unsigned 32bit integer with different EPdfAnnotationFlags OR'ed together. |
- See also:
- GetFlags
void PoDoFo::PdfAnnotation::SetOpen |
( |
bool |
b |
) |
|
Sets wether this annotation is initialy open. You should always set this true for popup annotations.
- Parameters:
-
void PoDoFo::PdfAnnotation::SetQuadPoints |
( |
const PdfArray & |
rQuadPoints |
) |
|
Set the quad points associated with the annotation (if appropriate). This array is used in text markup annotations to describe the regions affected by the markup (i.e. the hilighted words, one quadrilateral per word)
- Parameters:
-
| rQuadPoints | a PdfArray of 8xn numbers describing the x,y coordinates of BL BR TR TL corners of the quadrilaterals. |
void PoDoFo::PdfAnnotation::SetTitle |
( |
const PdfString & |
sTitle |
) |
|
Set the title of this annotation.
- Parameters:
-
| sTitle | title of the annoation as string in PDF format |
- See also:
- GetTitle