de::softpro::doc::SignDocChange Class Reference

A single change made to a PDF document after a signature. More...

#include <SignDocSDK-cpp.h>

Public Types
enum	Type {   t_other, t_field_added, t_field_removed, t_field_modified,   t_field_filled_in, t_annotation_added, t_annotation_removed, t_annotation_modified,   t_attachment_added, t_attachment_removed, t_attachment_modified, t_page_added,   t_page_removed, t_page_modified }
	Type of change. More...
Public Member Functions
	~SignDocChange ()
	Destructor.
Type	getType () const
	Get the type of the change.
std::string	getName (Encoding aEncoding) const
	Get the name of the changed field, annotation, or attachment.
const char *	getNameUTF8 () const
	Get the name of the changed field, annotation, or attachment as UTF-8-encoded C string.
int	getPage () const
	Get the page number of the change.
SignDocField::Type	getFieldType () const
	Get the type of the changed field.
const char *	getAnnotationType () const
	Get the type of the changed annotation.
	SignDocChange (SIGNDOC_Change *aP)
	Internal function.
SIGNDOC_Change *	getImpl ()
	Internal function.
const SIGNDOC_Change *	getImpl () const
	Internal function.
void	setImpl (SIGNDOC_Change *aP)
	Internal function.
Protected Member Functions
	SignDocChange ()
	Constructor (unavailable).

---

Detailed Description

A single change made to a PDF document after a signature.

See also:

SignDocSignature::getChange()

---

Member Enumeration Documentation

enum de::softpro::doc::SignDocChange::Type

Type of change.

See also:

getType()

Enumerator:

t_other	Other change. There will be one change of this type if there are any changes to the document which do not fit into the other categories described by enum Type.
t_field_added	A field has been added. getName() and getNameUTF8() return the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.
t_field_removed	A field has been removed. getName() and getNameUTF8() return the name of the field, getPage() returns the first page which had a widget of the field, getFieldType() returns the type of the field.
t_field_modified	Properties of a field have been modified. getName() and getNameUTF8() return the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.
t_field_filled_in	The value of a field has been changed. getName() and getNameUTF8() return the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.
t_annotation_added	An annotation has been added. This does not include widget annotations. getName() and getNameUTF8() return the name of the annotation. getPage() returns the page having the annotation, getAnnotationType() returns the type of the annotation.
t_annotation_removed	An annotation has been removed. This does not include widget annotations. getName() and getNameUTF8() return the name of the annotation. getPage() returns the page which had the annotation, getAnnotationType() returns the type of the annotation.
t_annotation_modified	An annotation has been modified. This does not include widget annotations. getName() and getNameUTF8() return the name of the annotation. getPage() returns the page having the annotation, getAnnotationType() returns the type of the annotation.
t_attachment_added	An annotation has been added. getName() and getNameUTF8() return the name of the attachment.
t_attachment_removed	An annotation has been removed. getName() and getNameUTF8() return the name of the attachment.
t_attachment_modified	An annotation has been modified. getName() and getNameUTF8() return the name of the attachment.
t_page_added	A page has been added. getPage() returns the number of the page in the newer version of the document.
t_page_removed	A page has been removed. getPage() returns the number of the page in the older version of the document.
t_page_modified	A page has been modified. getPage() returns the number of the page.

---

Constructor & Destructor Documentation

de::softpro::doc::SignDocChange::~SignDocChange

(

)

[inline]

Destructor.

de::softpro::doc::SignDocChange::SignDocChange

(

)

[inline, protected]

Constructor (unavailable).

Use SignDocDocument::getSignature().

de::softpro::doc::SignDocChange::SignDocChange

(

SIGNDOC_Change *

aP )

[inline]

Internal function.

---

Member Function Documentation

const char* de::softpro::doc::SignDocChange::getAnnotationType

(

)

const [inline]

Get the type of the changed annotation.

Returns:

The annotation type as string, empty if not known (for instance, if the change does not involve an annotation). This pointer will become invalid when this object is destroyed.

SignDocField::Type de::softpro::doc::SignDocChange::getFieldType

(

)

const [inline]

Get the type of the changed field.

Returns:

The field type, SignDocField::t_unknown if not known (for instance, if the change does not involve a field).

const SIGNDOC_Change* de::softpro::doc::SignDocChange::getImpl

(

)

const [inline]

Internal function.

SIGNDOC_Change* de::softpro::doc::SignDocChange::getImpl

(

)

[inline]

Internal function.

std::string de::softpro::doc::SignDocChange::getName

(

Encoding

aEncoding )

const [inline]

Get the name of the changed field, annotation, or attachment.

For change types ct_field_added, ct_field_removed, ct_field_modified, ct_annotation_added, ct_annotation_removed, ct_annotation_modified, ct_attachment_added, ct_attachment_removed, and ct_attachment_modified, the name of the changed field, annotation, or attachment can be retrieved by calling this function.

Parameters:

[in]

aEncoding

The encoding to be used for the return value.

Returns:

The name of the field, annotation, or attachment; empty if not available. If flag SignDocDocument::f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also:

getNameUTF8(), getType()

const char* de::softpro::doc::SignDocChange::getNameUTF8

(

)

const [inline]

Get the name of the changed field, annotation, or attachment as UTF-8-encoded C string.

For change types ct_field_added, ct_field_removed, ct_field_modified, ct_annotation_added, ct_annotation_removed, ct_annotation_modified, ct_attachment_added, ct_attachment_removed, and ct_attachment_modified, the name of the changed field, annotation, or attachment can be retrieved by calling this function.

Returns:

The name of the field, annotation, or attachment; empty if not available. This pointer will become invalid when this object is destroyed.

See also:

getName(), getType()

int de::softpro::doc::SignDocChange::getPage

(

)

const [inline]

Get the page number of the change.

Returns:

The one-based page number or 0 if not available. For removed items, the page number is in the document "as signed" by the signature described by the SignDocSignature object, for modified and added items, the page number is in the document "as signed" by the next signature (or the current version of the document if the SignDocSignature object describes the last signature).

Type de::softpro::doc::SignDocChange::getType

(

)

const [inline]

Get the type of the change.

Returns:

The type of the change.

void de::softpro::doc::SignDocChange::setImpl

(

SIGNDOC_Change *

aP )

[inline]

Internal function.

---

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

• SignDocSDK-cpp.h