PoDoFo 0.9.20
|
#include <PdfAnnotation.h>
An annotation to a PdfPage To create an annotation use PdfPage::CreateAnnotation
PdfObject * PdfAnnotation::GetAppearanceDictionaryObject | ( | ) |
PdfObject * PdfAnnotation::GetAppearanceStream | ( | PdfAppearanceType | appearance = PdfAppearanceType::Normal, |
const PdfName & | state = "" ) |
appearance | an apperance type to get |
state | a child state. Meaning depends on the annotation type |
PdfColor 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.
PdfAnnotationFlags PdfAnnotation::GetFlags | ( | ) | const |
Get the flags of this annotation.
|
inline |
Get the page of this PdfField
Rect PdfAnnotation::GetRect | ( | ) | const |
Get the rectangle of this annotation.
|
inline |
Get the type of this annotation
void PdfAnnotation::SetAppearanceStream | ( | const PdfXObjectForm & | xobj, |
PdfAppearanceType | appearance = PdfAppearanceType::Normal, | ||
const PdfName & | state = "" ) |
Set an appearance stream for this object to specify its visual appearance
xobj | an XObject form |
appearance | an apperance type to set |
state | the state for which set it the obj; states depend on the annotation type |
void PdfAnnotation::SetAppearanceStreamRaw | ( | const PdfXObjectForm & | xobj, |
PdfAppearanceType | appearance = PdfAppearanceType::Normal, | ||
const PdfName & | state = "" ) |
Set an appearance stream for this object to specify its visual appearance withot handling page rotations
xobj | an XObject form |
appearance | an apperance type to set |
state | the state for which set it the obj; states depend on the annotation type |
void PdfAnnotation::SetBorderStyle | ( | double | hCorner, |
double | vCorner, | ||
double | width ) |
Set the annotations border style.
hCorner | horitzontal corner radius |
vCorner | vertical corner radius |
width | width of border |
void PdfAnnotation::SetBorderStyle | ( | double | hCorner, |
double | vCorner, | ||
double | width, | ||
const PdfArray & | strokeStyle ) |
Set the annotations border style.
hCorner | horitzontal corner radius |
dVCorner | vertical corner radius |
width | width of border |
strokeStyle | a custom stroke style pattern |
Set the C key of the Annotation dictionary, which defines the color of the annotation, as per 8.4 of the pdf spec.
Set the text of this annotation.
contents | text of the annoation as string in PDF format |
void PdfAnnotation::SetFlags | ( | PdfAnnotationFlags | flags | ) |
Set the flags of this annotation.
void PdfAnnotation::SetRect | ( | const Rect & | rect | ) |
Set the rectangle of this annotation.
rect | rectangle to set |