SignDocSDK-cpp.h File Reference

SignDoc SDK C++ API. More...

#include <stddef.h>
#include <memory>
#include <string>
#include <vector>
#include <stdexcept>
#include "SignDocSDK-c.h"

Data Structures
class	InputStream
	Interface for an input stream, inspired by Java's java.io.InputStream. More...
class	UserInputStream
	Base class for InputStream implementations by user code. More...
class	LibraryInputStream
	Base class for InputStream implementations in SignDoc SDK. More...
class	FileInputStream
	Class implementing an InputStream reading from a file. More...
class	MemoryInputStream
	Class implementing an InputStream reading from memory. More...
class	OutputStream
	Interface for an output stream, inspired by Java's java.io.OutputStream. More...
class	UserOutputStream
	Base class for OutputStream implementations by user code. More...
class	LibraryOutputStream
	Base class for OutputStream implementations in SignDoc SDK. More...
class	FileOutputStream
	Class implementing an OutputStream writing to a file. More...
class	MemoryOutputStream
	Class implementing an OutputStream writing to memory and allocating memory as needed. More...
class	Point
	A point (document coordinates or canvas coordinates depending on context). More...
class	Rect
	A rectangle (document coordinates). More...
class	TimeStamper
	Interface for creating an RFC 3161 timestamp. More...
class	Source
	Data source. More...
class	SignPKCS7
	Interface for creating a PKCS #7 or CAdES signature. More...
class	SignRSA
	Interface for creating an RSA signature. More...
class	SignECDSA
	Interface for creating an ECDSA signature. More...
class	SignDocColor
	A color. More...
class	SignDocTextFieldAttributes
	Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only). More...
class	SignDocField
	One field of a document. More...
class	SignDocSignatureParameters
	Parameters for signing a document. More...
class	SignDocProperty
	One property, without value. More...
class	SignDocAnnotation
	An annotation. More...
class	SignDocTextCluster
	A cluster of Unicode code points and glyphs. More...
class	SignDocFindTextOccurrence
	Information about text found by SignDocDocument::findText(). More...
class	SignDocTextIterator
	An iterator for the text of a document. More...
class	SignDocRenderParameters
	Parameters for SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage(). More...
class	SignDocRenderOutput
	Output of SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage(). More...
class	SignDocAttachment
	Output of SignDocDocument::getAttachment(). More...
class	SignDocWatermark
	Parameters for a watermark. More...
class	SignDocVerificationParameters
	Parameters for verifying a certificate chain. More...
class	SignDocChange
	A single change made to a PDF document after a signature. More...
class	SignDocSignature
	Information about a signature field returned by SignDocDocument::getSignature(). More...
class	SignDocImageRect
	A rectangle for use with SignDocImage. More...
class	SignDocWeightedFrame
	A frame and its weight. More...
class	SignDocCheckSignatureParameters
	Parameters for SignDocSignatureData::checkReference() and SignDocSignatureData::checkSignature(). More...
class	SignDocCleanParameters
	Actions and parameters for SignDocImage::clean(). More...
class	SignDocImageParameters
	Parameters for saving images, converting images to bi-level images, and rendering biometric signatures as images. More...
class	SignDocMatchParameters
	Parameters for SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference(). More...
class	SignDocMatchResult
	Result of SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference(). More...
class	SignDocImage
	A bitmap image. More...
class	SignDocSignatureData
	Biometric data of handwritten signatures. More...
class	SignDocDocument
	An interface for SignDoc documents. More...
class	SignDocDocumentHandler
	Handler for one document type (internal interface). More...
class	SignDocDocumentLoader
	Create SignDocDocument objects. More...
class	SignDocVerificationResult
	Information about a signature field returned by SignDocDocument::verifySignature() or SignDocDocument::verifySignature2(). More...
class	SignDocPdfDocumentHandler
	SignDoc document handler for PDF documents. More...
class	SignDocTiffDocumentHandler
	SignDoc document handler for TIFF documents. More...

Namespaces
	de
	de::softpro
	de::softpro::doc

Enumerations
enum	ReturnCode {   rc_ok, rc_invalid_argument, rc_field_not_found, rc_invalid_profile,   rc_invalid_image, rc_type_mismatch, rc_font_not_found, rc_unused_7,   rc_not_supported, rc_io_error, rc_not_verified, rc_property_not_found,   rc_page_not_found, rc_wrong_collection, rc_field_exists, rc_license_error,   rc_unexpected_error, rc_cancelled, rc_no_biometric_data, rc_unused_19,   rc_field_not_signed, rc_invalid_signature, rc_annotation_not_found, rc_attachment_not_found,   rc_attachment_exists, rc_no_certificate, rc_ambiguous_certificate, rc_not_allowed,   rc_invalid_structure, rc_unknown_parameter, rc_invalid_value, rc_not_available }
	Return codes. More...
enum	Encoding { enc_native, enc_utf_8, enc_latin_1 }
	Encoding of strings. More...

Functions
void	SignDoc_throw (SIGNDOC_Exception *aEx)
	Internal function. More...
void	SIGNDOC_catch (SIGNDOC_Exception **aEx, std::exception &aInput)
	Internal function. More...
SignDocVerificationResult *	makeSignDocVerificationResult (SIGNDOC_VerificationResult *aP)
	Internal function. More...
void	assignArray (std::vector< unsigned char > &aDst, SIGNDOC_ByteArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< std::vector< unsigned char > > &aDst, SIGNDOC_ByteArrayArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< int > &aDst, SIGNDOC_IntArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< std::string > &aDst, SIGNDOC_StringArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< Rect > &aDst, SIGNDOC_RectArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< SignDocField > &aDst, SIGNDOC_FieldArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< SignDocProperty > &aDst, SIGNDOC_PropertyArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< SignDocFindTextOccurrence > &aDst, SIGNDOC_FindTextOccurrenceArray *aSrc)
	Internal function. More...
void	assignArray (std::vector< SignDocWeightedFrame > &aDst, SIGNDOC_WeightedFrameArray *aSrc)
	Internal function. More...

Detailed Description

SignDoc SDK C++ API.

Author

ema

This header contains the definition of class SignDocDocument and related classes.