#include <PdfSignatureField.h>

Inherits PoDoFo::PdfField.

Public Member Functions
	PdfSignatureField (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc)

	PdfSignatureField (PdfAnnotation pWidget, PdfAcroForm pParent, PdfDocument *pDoc, bool bInit=true)

	PdfSignatureField (PdfAnnotation *pWidget)

void	SetAppearanceStream (PdfXObject *pObject, EPdfAnnotationAppearance eAppearance=ePdfAnnotationAppearance_Normal, const PdfName &state="")

void	SetSignature (const PdfData &signatureData)

void	SetSignatureReason (const PdfString &rsText)

void	SetSignatureLocation (const PdfString &rsText)

void	SetSignatureCreator (const PdfName &creator)

void	SetSignatureDate (const PdfDate &sigDate)

void	AddCertificationReference (PdfObject *pDocumentCatalog, EPdfCertPermission perm=ePdfCertPermission_NoPerms)

PdfObject *	GetSignatureObject (void) const

void	EnsureSignatureObject (void)

Public Member Functions inherited from PoDoFo::PdfField
	PdfField (PdfObject pObject, PdfAnnotation pWidget)

	PdfField (const PdfField &rhs)

PdfPage *	GetPage () const

void	SetHighlightingMode (EPdfHighlightingMode eMode)

EPdfHighlightingMode	GetHighlightingMode () const

void	SetBorderColorTransparent ()

void	SetBorderColor (double dGray)

void	SetBorderColor (double dRed, double dGreen, double dBlue)

void	SetBorderColor (double dCyan, double dMagenta, double dYellow, double dBlack)

void	SetBackgroundColorTransparent ()

void	SetBackgroundColor (double dGray)

void	SetBackgroundColor (double dRed, double dGreen, double dBlue)

void	SetBackgroundColor (double dCyan, double dMagenta, double dYellow, double dBlack)

void	SetFieldName (const PdfString &rsName)

PdfString	GetFieldName () const

void	SetAlternateName (const PdfString &rsName)

PdfString	GetAlternateName () const

void	SetMappingName (const PdfString &rsName)

PdfString	GetMappingName () const

void	SetReadOnly (bool bReadOnly)

bool	IsReadOnly () const

void	SetRequired (bool bRequired)

bool	IsRequired () const

void	SetExport (bool bExport)

bool	IsExport () const

EPdfField	GetType () const

Additional Inherited Members
Protected Member Functions inherited from PoDoFo::PdfField
	PdfField (EPdfField eField, PdfAnnotation pWidget, PdfAcroForm pParent)

void	SetFieldFlag (long lValue, bool bSet)

bool	GetFieldFlag (long lValue, bool bDefault) const

PdfObject *	GetAppearanceCharacteristics (bool bCreate) const

Detailed Description

Signature field

Constructor & Destructor Documentation

PoDoFo::PdfSignatureField::PdfSignatureField	(	PdfPage *	pPage,
		const PdfRect &	rRect,
		PdfDocument *	pDoc
	)

Create a new PdfSignatureField

PoDoFo::PdfSignatureField::PdfSignatureField	(	PdfAnnotation *	pWidget,
		PdfAcroForm *	pParent,
		PdfDocument *	pDoc,
		bool	bInit = `true`
	)

Create a new PdfSignatureField

Parameters

bInit creates a signature field with/without a /V key

PoDoFo::PdfSignatureField::PdfSignatureField ( PdfAnnotation * pWidget )

Creates a PdfSignatureField from an existing PdfAnnotation, which should be an annotation with a field type Sig.

Parameters

pWidget the annotation to create from

Member Function Documentation

void PoDoFo::PdfSignatureField::AddCertificationReference	(	PdfObject *	pDocumentCatalog,
		EPdfCertPermission	perm = `ePdfCertPermission_NoPerms`
	)

Add certification dictionaries and references to document catalog.

Parameters

pDocumentCatalog	the catalog of current document
perm	document modification permission

void PoDoFo::PdfSignatureField::EnsureSignatureObject ( void )

Ensures that the signature field has set a signature object. The function does nothing, if the signature object is already set. This is useful for cases when the signature field had been created from an existing annotation, which didn't have it set.

PdfObject * PoDoFo::PdfSignatureField::GetSignatureObject ( void ) const

Returns signature object for this signature field. It can be NULL, when the signature field was created from an existing annotation and it didn't have set it.

Returns: associated signature object, or NULL

void PoDoFo::PdfSignatureField::SetAppearanceStream	(	PdfXObject *	pObject,
		EPdfAnnotationAppearance	eAppearance = `ePdfAnnotationAppearance_Normal`,
		const PdfName &	state = `""`
	)

Set an appearance stream for this signature field to specify its visual appearance

Parameters

pObject	an XObject
eAppearance	an appearance type to set
state	the state for which set it the pObject; states depend on the annotation type

void PoDoFo::PdfSignatureField::SetSignature ( const PdfData & signatureData )

Create space for signature

Parameters

signatureData String used to locate reserved space for signature. This string will be replaiced with signature.

Structure of the PDF file - before signing: <</ByteRange[ 0 1234567890 1234567890 1234567890]/Contents<signatureData> Have to be replaiced with the following structure: <</ByteRange[ 0 count pos count]/Contents<real signature ...0-padding>

void PoDoFo::PdfSignatureField::SetSignatureCreator ( const PdfName & creator )

Set the creator of the signature

Parameters

creator the creator of the signature

void PoDoFo::PdfSignatureField::SetSignatureDate ( const PdfDate & sigDate )

Date of signature

void PoDoFo::PdfSignatureField::SetSignatureLocation ( const PdfString & rsText )

Set location of the signature

Parameters

rsText the location of signature

void PoDoFo::PdfSignatureField::SetSignatureReason ( const PdfString & rsText )

Set reason of the signature

Parameters

rsText the reason of signature

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation