Index: public/fpdf_ext.h |
diff --git a/public/fpdf_ext.h b/public/fpdf_ext.h |
index c80dcbbf58fe5e78138e1da59ac4b8bcd8aff029..d00c568241fed9735a508e1d7257201c11331e18 100644 |
--- a/public/fpdf_ext.h |
+++ b/public/fpdf_ext.h |
@@ -11,98 +11,87 @@ |
#ifdef __cplusplus |
extern "C" { |
-#endif |
+#endif // __cplusplus |
-// flags for type of unsupport object. |
+// Unsupported XFA form. |
#define FPDF_UNSP_DOC_XFAFORM 1 |
+// Unsupported portable collection. |
#define FPDF_UNSP_DOC_PORTABLECOLLECTION 2 |
+// Unsupported attachment. |
#define FPDF_UNSP_DOC_ATTACHMENT 3 |
+// Unsupported security. |
#define FPDF_UNSP_DOC_SECURITY 4 |
+// Unsupported shared review. |
#define FPDF_UNSP_DOC_SHAREDREVIEW 5 |
+// Unsupported shared form, acrobat. |
#define FPDF_UNSP_DOC_SHAREDFORM_ACROBAT 6 |
+// Unsupported shared form, filesystem. |
#define FPDF_UNSP_DOC_SHAREDFORM_FILESYSTEM 7 |
+// Unsupported shared form, email. |
#define FPDF_UNSP_DOC_SHAREDFORM_EMAIL 8 |
+// Unsupported 3D annotation. |
#define FPDF_UNSP_ANNOT_3DANNOT 11 |
+// Unsupported movie annotation. |
#define FPDF_UNSP_ANNOT_MOVIE 12 |
+// Unsupported sound annotation. |
#define FPDF_UNSP_ANNOT_SOUND 13 |
+// Unsupported screen media annotation. |
#define FPDF_UNSP_ANNOT_SCREEN_MEDIA 14 |
+// Unsupported screen rich media annotation. |
#define FPDF_UNSP_ANNOT_SCREEN_RICHMEDIA 15 |
+// Unsupported attachment annotation. |
#define FPDF_UNSP_ANNOT_ATTACHMENT 16 |
+// Unsupported signature annotation. |
#define FPDF_UNSP_ANNOT_SIG 17 |
+// Interface for unsupported feature notifications. |
typedef struct _UNSUPPORT_INFO { |
- /** |
- * Version number of the interface. Currently must be 1. |
- **/ |
+ // Version number of the interface. Must be 1. |
int version; |
- /** |
- * Method: FSDK_UnSupport_Handler |
- * UnSupport Object process handling function. |
- * Interface Version: |
- * 1 |
- * Implementation Required: |
- * Yes |
- * Parameters: |
- * pThis - Pointer to the interface structure itself. |
- * nType - The type of unsupportObject |
- * Return value: |
- * None. |
- * */ |
- |
+ // Unsupported object notification function. |
+ // Interface Version: 1 |
+ // Implementation Required: Yes |
+ // |
+ // pThis - pointer to the interface structure. |
+ // nType - the type of unsupported object. One of the |FPDF_UNSP_*| entries. |
void (*FSDK_UnSupport_Handler)(struct _UNSUPPORT_INFO* pThis, int nType); |
} UNSUPPORT_INFO; |
-/** |
- * Function: FSDK_SetUnSpObjProcessHandler |
- * Setup A UnSupport Object process handler for foxit sdk. |
- * Parameters: |
- * unsp_info - Pointer to a UNSUPPORT_INFO structure. |
- * Return Value: |
- * TRUE means successful. FALSE means fails. |
- **/ |
- |
+// Setup an unsupported object handler. |
+// |
+// unsp_info - Pointer to an UNSUPPORT_INFO structure. |
+// |
+// Returns TRUE on success. |
DLLEXPORT FPDF_BOOL STDCALL |
FSDK_SetUnSpObjProcessHandler(UNSUPPORT_INFO* unsp_info); |
-// flags for page mode. |
- |
-// Unknown value |
+// Unknown page mode. |
#define PAGEMODE_UNKNOWN -1 |
- |
-// Neither document outline nor thumbnail images visible |
+// Document outline, and thumbnails hidden. |
#define PAGEMODE_USENONE 0 |
- |
-// Document outline visible |
+// Document outline visible. |
#define PAGEMODE_USEOUTLINES 1 |
- |
-// Thumbnial images visible |
+// Thumbnail images visible. |
#define PAGEMODE_USETHUMBS 2 |
- |
-// Full-screen mode, with no menu bar, window controls, or any other window |
-// visible |
+// Full-screen mode, no menu bar, window controls, or other decorations visible. |
#define PAGEMODE_FULLSCREEN 3 |
- |
-// Optional content group panel visible |
+// Optional content group panel visible. |
#define PAGEMODE_USEOC 4 |
- |
-// Attachments panel visible |
+// Attachments panel visible. |
#define PAGEMODE_USEATTACHMENTS 5 |
-/** |
- * Function: FPDFDoc_GetPageMode |
- * Get the document's PageMode(How the document should be displayed |
- *when opened) |
- * Parameters: |
- * doc - Handle to document. Returned by FPDF_LoadDocument |
- *function. |
- * Return Value: |
- * The flags for page mode. |
- **/ |
+// Get the document's PageMode. |
+// |
+// doc - Handle to document. |
+// |
+// Returns one of the |PAGEMODE_*| flags defined above. |
+// |
+// The page mode defines how the document should be initially displayed. |
DLLEXPORT int FPDFDoc_GetPageMode(FPDF_DOCUMENT document); |
#ifdef __cplusplus |
-} |
-#endif |
+} // extern "C" |
+#endif // __cplusplus |
#endif // PUBLIC_FPDF_EXT_H_ |