An annotation to a PdfPage To create an annotation use PdfPage::CreateAnnotation. More...

#include <PdfAnnotation.h>

Inherits PoDoFo::PdfDictionaryElement.

Inherited by PoDoFo::PdfAnnotationActionBase, PoDoFo::PdfAnnotationCaret, PoDoFo::PdfAnnotationCircle, PoDoFo::PdfAnnotationFileAttachment, PoDoFo::PdfAnnotationFreeText, PoDoFo::PdfAnnotationInk, PoDoFo::PdfAnnotationLine, PoDoFo::PdfAnnotationModel3D, PoDoFo::PdfAnnotationMovie, PoDoFo::PdfAnnotationPolyLine, PoDoFo::PdfAnnotationPolygon, PoDoFo::PdfAnnotationPopup, PoDoFo::PdfAnnotationPrinterMark, PoDoFo::PdfAnnotationProjection, PoDoFo::PdfAnnotationRedact, PoDoFo::PdfAnnotationRichMedia, PoDoFo::PdfAnnotationSound, PoDoFo::PdfAnnotationSquare, PoDoFo::PdfAnnotationStamp, PoDoFo::PdfAnnotationText, PoDoFo::PdfAnnotationTextMarkupBase, PoDoFo::PdfAnnotationTrapNet, PoDoFo::PdfAnnotationWatermark, and PoDoFo::PdfAnnotationWebMedia.

Public Member Functions
void	SetAppearanceStream (const PdfXObject &xobj, PdfAppearanceType appearance=PdfAppearanceType::Normal, const PdfName &state={ }, bool skipSelectedState=false)
	Set an appearance stream for this object to specify its visual appearance.

void	SetAppearanceStreamRaw (const PdfXObject &xobj, PdfAppearanceType appearance=PdfAppearanceType::Normal, const PdfName &state={ }, bool skipSelectedState=false)
	Set an appearance stream for this object to specify its visual appearance without handling page rotations.

void	GetAppearanceStreams (std::vector< PdfAppearanceStream > &states) const
	Get a list of qualified appearance streams.

void	ClearAppearances ()

PdfObject *	GetAppearanceDictionaryObject ()

const PdfObject *	GetAppearanceDictionaryObject () const

PdfObject *	GetAppearanceStream (PdfAppearanceType appearance=PdfAppearanceType::Normal, const std::string_view &state={ })

const PdfObject *	GetAppearanceStream (PdfAppearanceType appearance=PdfAppearanceType::Normal, const std::string_view &state={ }) const

Rect	GetRect () const
	Get the rectangle of this annotation.

void	SetRect (const Rect &rect)
	Set the rectangle of this annotation.

Corners	GetRectRaw () const

void	SetRectRaw (const Corners &rect)

void	SetFlags (PdfAnnotationFlags flags)
	Set the flags of this annotation.

PdfAnnotationFlags	GetFlags () const
	Get the flags of this annotation.

void	SetBorderStyle (double hCorner, double vCorner, double width)
	Set the annotations border style.

void	SetBorderStyle (double hCorner, double vCorner, double width, const PdfArray &strokeStyle)
	Set the annotations border style.

void	SetTitle (nullable< const PdfString & > title)
	Set the title of this annotation.

nullable< const PdfString & >	GetTitle () const
	Get the title of this annotation.

void	SetContents (nullable< const PdfString & > contents)
	Set the text of this annotation.

nullable< const PdfString & >	GetContents () const
	Get the text of this annotation.

PdfColor	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.

void	SetColor (nullable< const PdfColor & > color)
	Set the C key of the Annotation dictionary, which defines the color of the annotation, as per 8.4 of the pdf spec.

PdfAnnotationType	GetType () const
	Get the type of this annotation.

PdfPage *	GetPage ()
	Get the page of this PdfField.

const PdfPage *	GetPage () const

PdfPage &	MustGetPage ()

const PdfPage &	MustGetPage () const

Static Public Member Functions
static bool	TryCreateFromObject (PdfObject &obj, std::unique_ptr< PdfAnnotation > &xobj)

static bool	TryCreateFromObject (const PdfObject &obj, std::unique_ptr< const PdfAnnotation > &xobj)

template<typename TAnnotation >
static bool	TryCreateFromObject (PdfObject &obj, std::unique_ptr< TAnnotation > &xobj)

template<typename TAnnotation >
static bool	TryCreateFromObject (const PdfObject &obj, std::unique_ptr< const TAnnotation > &xobj)

Friends
class	PdfAnnotationCollection

class	PdfAnnotationTextMarkupBase

class	PdfAnnotationPopup

class	PdfAnnotationText

class	PdfAnnotationCaret

class	PdfAnnotationFileAttachment

class	PdfAnnotationFreeText

class	PdfAnnotationHighlight

class	PdfAnnotationInk

class	PdfAnnotationLine

class	PdfAnnotationModel3D

class	PdfAnnotationMovie

class	PdfAnnotationPolygon

class	PdfAnnotationPolyLine

class	PdfAnnotationPrinterMark

class	PdfAnnotationRichMedia

class	PdfAnnotationScreen

class	PdfAnnotationSquiggly

class	PdfAnnotationStrikeOut

class	PdfAnnotationSound

class	PdfAnnotationSquare

class	PdfAnnotationCircle

class	PdfAnnotationStamp

class	PdfAnnotationTrapNet

class	PdfAnnotationUnderline

class	PdfAnnotationWatermark

class	PdfAnnotationWebMedia

class	PdfAnnotationRedact

class	PdfAnnotationProjection

class	PdfAnnotationActionBase

class	PdfToggleButton

Detailed Description

An annotation to a PdfPage To create an annotation use PdfPage::CreateAnnotation.

See also: PdfPage::CreateAnnotation

Member Function Documentation

◆ GetAppearanceDictionaryObject()

PdfObject * PdfAnnotation::GetAppearanceDictionaryObject ( )

Returns: the appearance /AP object for this annotation

◆ GetAppearanceStream()

PdfObject * PoDoFo::PdfAnnotation::GetAppearanceStream	(	PdfAppearanceType	appearance = `PdfAppearanceType::Normal`,
		const std::string_view &	state = `{ }`
	)

Returns: the appearance stream for this object

Parameters

appearance	an appearance type to get
state	a child state. Meaning depends on the annotation type

◆ GetContents()

nullable< const PdfString & > PdfAnnotation::GetContents ( ) const

Get the text of this annotation.

Returns: the contents of this annotation

See also: SetContents

◆ GetFlags()

PdfAnnotationFlags PdfAnnotation::GetFlags ( ) const

Get the flags of this annotation.

Returns: the flags which is an unsigned 32bit integer with different PdfAnnotationFlags OR'ed together.

See also: SetFlags

◆ GetPage()

PdfPage * PoDoFo::PdfAnnotation::GetPage ( )

inline

Get the page of this PdfField.

Returns: the page of this PdfField

◆ GetRect()

Rect PdfAnnotation::GetRect ( ) const

Get the rectangle of this annotation.

Returns: a rectangle. It's oriented according to the canonical PDF coordinate system

◆ GetTitle()

nullable< const PdfString & > PdfAnnotation::GetTitle ( ) const

Get the title of this annotation.

Returns: the title of this annotation

See also: SetTitle

◆ GetType()

PdfAnnotationType PoDoFo::PdfAnnotation::GetType ( ) const

inline

Get the type of this annotation.

Returns: the annotation type

◆ SetAppearanceStream()

void PdfAnnotation::SetAppearanceStream	(	const PdfXObject &	xobj,
		PdfAppearanceType	appearance = `PdfAppearanceType::Normal`,
		const PdfName &	state = `{ }`,
		bool	skipSelectedState = `false`
	)

Set an appearance stream for this object to specify its visual appearance.

Parameters

xobj	an XObject form
appearance	an appearance type to set
state	the state for which set it the obj; states depend on the annotation type
skipSelectedState	skip setting the selected state, if non null

◆ SetAppearanceStreamRaw()

void PdfAnnotation::SetAppearanceStreamRaw	(	const PdfXObject &	xobj,
		PdfAppearanceType	appearance = `PdfAppearanceType::Normal`,
		const PdfName &	state = `{ }`,
		bool	skipSelectedState = `false`
	)

Set an appearance stream for this object to specify its visual appearance without handling page rotations.

Parameters

xobj	an XObject form
appearance	an appearance type to set
state	the state for which set it the obj; states depend on the annotation type
skipSelectedState	skip setting the selected state, if non null

◆ SetBorderStyle() [1/2]

void PdfAnnotation::SetBorderStyle	(	double	hCorner,
		double	vCorner,
		double	width
	)

Set the annotations border style.

Parameters

hCorner	horitzontal corner radius
vCorner	vertical corner radius
width	width of border

◆ SetBorderStyle() [2/2]

void PdfAnnotation::SetBorderStyle	(	double	hCorner,
		double	vCorner,
		double	width,
		const PdfArray &	strokeStyle
	)

Set the annotations border style.

Parameters

hCorner	horitzontal corner radius
dVCorner	vertical corner radius
width	width of border
strokeStyle	a custom stroke style pattern

◆ SetContents()

void PdfAnnotation::SetContents ( nullable< const PdfString & > contents )

Set the text of this annotation.

Parameters

contents text of the annotation as string in PDF format

See also: GetContents

◆ SetFlags()

void PdfAnnotation::SetFlags ( PdfAnnotationFlags flags )

Set the flags of this annotation.

See also: GetFlags

◆ SetRect()

void PdfAnnotation::SetRect ( const Rect & rect )

Set the rectangle of this annotation.

Parameters

rect	rectangle to set. It's oriented according to the canonical PDF coordinate system

◆ SetTitle()

void PdfAnnotation::SetTitle ( nullable< const PdfString & > title )

Set the title of this annotation.

Parameters

title title of the annotation as string in PDF format

See also: GetTitle

The documentation for this class was generated from the following files:

src/podofo/main/PdfAnnotation.h
src/podofo/main/PdfAnnotation.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ GetAppearanceDictionaryObject()

◆ GetAppearanceStream()

◆ GetContents()

◆ GetFlags()

◆ GetPage()

◆ GetRect()

◆ GetTitle()

◆ GetType()

◆ SetAppearanceStream()

◆ SetAppearanceStreamRaw()

◆ SetBorderStyle() [1/2]

◆ SetBorderStyle() [2/2]

◆ SetContents()

◆ SetFlags()

◆ SetRect()

◆ SetTitle()