Structure for Signature Icon Provider Handler. More...

Public Attributes
FS_LPVOID	clientData
	User-defined data. More...

FS_RESULT(*	GetIcon )(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FSCRT_BITMAP *bitmap)
	Callback function to retrieve the specific state icon of a signature. More...

FS_RESULT(*	GetIconFitMode )(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FS_INT32 *fitMode)
	Callback function to receive the display mode of the specified state icon of a signature. More...

FS_RESULT(*	NeedRotate )(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FS_BOOL *needRotate)
	Callback function to retrieve whether the signature specified state icon will be rotated after the page rotation. More...

Detailed Description

Structure for Signature Icon Provider Handler.

Note: This is a handler and is implemented by caller.
When host application wants to use customized icon according to signature state, this handler should be implement and function FSPDF_Signature_SetIconProvider should be called to set this handler to Foxit PDF SDK.

Member Data Documentation

FS_LPVOID FSPDF_SIGNATUREICONPROVIDER::clientData

User-defined data.

FS_RESULT(* FSPDF_SIGNATUREICONPROVIDER::GetIcon) (FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FSCRT_BITMAP *bitmap)

Callback function to retrieve the specific state icon of a signature.

Parameters

[in]	clientData	Pointer to any type data which indicates user-defined data.
[in]	sig	Handle to a FSPDF_SIGNATURE object returned by function FSPDF_Doc_GetSignature or FSPDF_Signature_Add.
[in]	nState	The state of signature. Please refer to macro definitions FSPDF_SIGNATURE_STATE_XXX and this should be one of these macros.
[out]	bitmap	Handle to a FSCRT_BITMAP object.

Returns: FSCRT_ERRCODE_SUCCESS for success.
FSCRT_ERRCODE_ERROR if any internal running error occurs.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.

Note: Host application provides this callback method for custom sign mechanism. This callback function will be triggered when Foxit PDF SDK is to display state icon of a signature if customized state icons are used.

FS_RESULT(* FSPDF_SIGNATUREICONPROVIDER::GetIconFitMode) (FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FS_INT32 *fitMode)

Callback function to receive the display mode of the specified state icon of a signature.

Parameters

[in]	clientData	Pointer to any type data which indicates user-defined data.
[in]	sig	Handle to a FSPDF_SIGNATURE object returned by function FSPDF_Doc_GetSignature or FSPDF_Signature_Add.
[in]	nState	The state of signature. Please refer to macro definitions FSPDF_SIGNATURE_STATE_XXX and this should be one of these macros.
[out]	fitMode	16-bit integer size of display mode. Please refer to macro definitions FSPDF_SIGNATURE_ICONFITMODE_XXX and this would be one of these macros.

Returns: FSCRT_ERRCODE_SUCCESS for success.
FSCRT_ERRCODE_ERROR if any internal running error occurs.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.

Note: Host application provides this callback method for custom sign mechanism. This callback function will be triggered when Foxit PDF SDK displays state icon of a signature if customized state icons are used.

FS_RESULT(* FSPDF_SIGNATUREICONPROVIDER::NeedRotate) (FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FS_BOOL *needRotate)

Callback function to retrieve whether the signature specified state icon will be rotated after the page rotation.

Parameters

[in]	clientData	Pointer to any type data which indicates user-defined data.
[in]	sig	Handle to a FSPDF_SIGNATURE object returned by function FSPDF_Doc_GetSignature or FSPDF_Signature_Add.
[in]	nState	The state of signature. Please refer to macro definitions FSPDF_SIGNATURE_STATE_XXX and this should be one of these macros.
[out]	needRotate	TRUE means along with the rotation of the page otherwise FALSE means not with the rotating page.

Returns: FSCRT_ERRCODE_SUCCESS for success.
FSCRT_ERRCODE_ERROR if any internal running error occurs.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.

Note: Host application provides this callback method for custom sign mechanism. This callback function will be triggered when Foxit PDF SDK displays state icon of a signature if customized state icons are used.

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