Structure for the provider of alternate icons. More...
#include <fpdf_annot_w.h>
Public Attributes | |
| FS_DWORD | lStructSize |
| The size of the data structure. It must be set to sizeof(FSPDF_ICONPROVIDER). | |
| FS_LPVOID | clientData |
| A user pointer, used by the application. | |
| FS_RESULT(* | Release )(FS_LPVOID clientData) |
| A callback function can be called when to release everything. More... | |
| FS_RESULT(* | GetProviderID )(FS_LPVOID clientData, FSCRT_BSTR *str, FS_DWORD *ver) |
| A callback function retrieves identity info of icon provider. More... | |
| FS_RESULT(* | HasIcon )(FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_BOOL *hasIcon) |
| A callback function determines whether icon provider supports an icon. More... | |
| FS_RESULT(* | CanChangeColor )(FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_BOOL *canChange) |
| A callback function determines whether supports to change icon color. More... | |
| FS_RESULT(* | GetIcon )(FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_ARGB color, FSCRT_PAGE *page) |
| A callback function retrieves icon as PDF page contents. More... | |
| FS_RESULT(* | SetShadingColor )(FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_ARGB refColor, FS_INT32 shadingIndex, FS_ARGB *c1, FS_ARGB *c2) |
| A callback function sets shading colors if an icon supports shading. Currently, we support only Type-2 shading settings with two color values. More... | |
| FS_RESULT(* | GetDisplaySize )(FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_FLOAT *width, FS_FLOAT *height) |
| A callback function retrieves icon size when display, in device size(pixel normally). More... | |
Structure for the provider of alternate icons.
| FS_RESULT(* FSPDF_ICONPROVIDER::CanChangeColor) (FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_BOOL *canChange) |
A callback function determines whether supports to change icon color.
| [in] | clientData | The user-supplied data. |
| [in] | iconType | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the type string of icon. Support types: "Text", "FileAttachment", and "Stamp". |
| [in] | iconID | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the identity string of icon. Please refer to "note" description part in callback function FSPDF_ICONPROVIDER::HasIcon for more information. |
| [out] | canChange | Pointer to a FS_BOOL object that receives a boolean value which indicates whether the color of icon could be changed or not. |
| FS_RESULT(* FSPDF_ICONPROVIDER::GetDisplaySize) (FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_FLOAT *width, FS_FLOAT *height) |
A callback function retrieves icon size when display, in device size(pixel normally).
| [in] | clientData | The user-supplied data. |
| [in] | iconType | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the type string of icon. Support types: "Text", "FileAttachment", and "Stamp". |
| [in] | iconID | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the identity string of icon. Please refer to "note" description part in callback function FSPDF_ICONPROVIDER::HasIcon for more information. |
| [out] | width | Pointer to a FS_FLOAT object that receives the width of icon. |
| [out] | height | Pointer to a FS_FLOAT object that receives the height of icon. |
| FS_RESULT(* FSPDF_ICONPROVIDER::GetIcon) (FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_ARGB color, FSCRT_PAGE *page) |
A callback function retrieves icon as PDF page contents.
| [in] | clientData | The user-supplied data. |
| [in] | iconType | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the type string of icon. Support types: "Text", "FileAttachment", and "Stamp". |
| [in] | iconID | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the identity string of icon. Please refer to "note" description part in callback function FSPDF_ICONPROVIDER::HasIcon for more information. |
| [in] | color | Color if icon needs. Format: 0xAARRGGBB and alpha value is ignored. |
| [out] | page | Pointer to a FSCRT_PAGE handle that receives a page object. If there is any error, it will be NULL. |
| FS_RESULT(* FSPDF_ICONPROVIDER::GetProviderID) (FS_LPVOID clientData, FSCRT_BSTR *str, FS_DWORD *ver) |
A callback function retrieves identity info of icon provider.
| [in] | clientData | The user-supplied data. |
| [out] | str | Pointer to a FSCRT_BSTR structure that receives a UTF-8 string which indicates the identity name string of icon provider. |
| [out] | ver | Pointer to a FS_DWORD object that receives the version number of icon provider. |
| FS_RESULT(* FSPDF_ICONPROVIDER::HasIcon) (FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_BOOL *hasIcon) |
A callback function determines whether icon provider supports an icon.
| [in] | clientData | The user-supplied data. |
| [in] | iconType | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the type string of icon. Support types: "Text", "FileAttachment", and "Stamp". |
| [in] | iconID | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the identity string of icon. Please refer to note part for more information. |
| [out] | hasIcon | Whether an icon is provided. |
| FS_RESULT(* FSPDF_ICONPROVIDER::Release) (FS_LPVOID clientData) |
A callback function can be called when to release everything.
| [in] | clientData | The user-supplied data. |
| FS_RESULT(* FSPDF_ICONPROVIDER::SetShadingColor) (FS_LPVOID clientData, const FSCRT_BSTR *iconType, const FSCRT_BSTR *iconID, FS_ARGB refColor, FS_INT32 shadingIndex, FS_ARGB *c1, FS_ARGB *c2) |
A callback function sets shading colors if an icon supports shading. Currently, we support only Type-2 shading settings with two color values.
| [in] | clientData | The user-supplied data. |
| [in] | iconType | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the type string of icon. Support types: "Text", "FileAttachment", and "Stamp". |
| [in] | iconID | Pointer to a FSCRT_BSTR structure that specifies a UTF-8 string which indicates the identity string of icon. Please refer to "note" description part in callback function FSPDF_ICONPROVIDER::HasIcon for more information. |
| [in] | refColor | Referenced color to set, alpha component is ignored. |
| [in] | shadingIndex | Index color of shading. If shading colors are more than one, this function will be called multiple times. |
| [out] | c1 | Pointer to a FS_ARGB object that receives the first color value of shading. |
| [out] | c2 | Pointer to a FS_ARGB object that receives the second color value of shading. |