Merge XFA to PDFium master at 4dc95e7 on 10/28/2014
[pdfium.git] / fpdfsdk / include / fpdfview.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4  
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7
8 #ifndef _FPDFVIEW_H_
9 #define _FPDFVIEW_H_
10
11 #if defined(_WIN32) && !defined(__WINDOWS__)
12 #include <windows.h>
13 #endif
14
15 // Data types
16 typedef void*   FPDF_MODULEMGR;
17
18 // PDF types
19 typedef void*   FPDF_DOCUMENT;          
20 typedef void*   FPDF_PAGE;                      
21 typedef void*   FPDF_WIDGET;    
22 typedef void*   FPDF_STRINGHANDLE;
23 typedef void*   FPDF_PAGEOBJECT;        // Page object(text, path, etc)
24 typedef void*   FPDF_PATH;
25 typedef void*   FPDF_CLIPPATH;  
26 typedef void*   FPDF_BITMAP;    
27 typedef void*   FPDF_FONT;                      
28
29 typedef void*   FPDF_TEXTPAGE;
30 typedef void*   FPDF_SCHHANDLE;
31 typedef void*   FPDF_PAGELINK;
32 typedef void*   FPDF_HMODULE;
33 typedef void*   FPDF_DOCSCHHANDLE;
34
35 typedef void*   FPDF_BOOKMARK;
36 typedef void*   FPDF_DEST;
37 typedef void*   FPDF_ACTION;
38 typedef void*   FPDF_LINK;
39 typedef void*   FPDF_PAGERANGE;
40
41 // Basic data types
42 typedef void*                   FPDF_LPVOID;
43 typedef void const*             FPDF_LPCVOID;
44 typedef int                             FPDF_RESULT;
45 typedef int                             FPDF_BOOL;
46 typedef int                             FPDF_ERROR;     
47 typedef unsigned long   FPDF_DWORD;
48
49 typedef float                   FS_FLOAT;
50
51 // Duplex types
52 typedef enum _FPDF_DUPLEXTYPE_ {
53     DuplexUndefined = 0,
54     Simplex,
55     DuplexFlipShortEdge,
56     DuplexFlipLongEdge
57 } FPDF_DUPLEXTYPE;
58
59 // String types
60 typedef unsigned short                  FPDF_WCHAR;
61 typedef unsigned char const*    FPDF_LPCBYTE;
62 typedef char const*                             FPDF_LPCSTR;
63
64 // FPDFSDK may use three types of strings: byte string, wide string (UTF-16LE encoded), and platform dependent string
65 typedef const char*                             FPDF_BYTESTRING;
66
67 typedef const unsigned short*   FPDF_WIDESTRING;                // Foxit PDF SDK always use UTF-16LE encoding wide string,
68                                                                                                                 // each character use 2 bytes (except surrogation), with low byte first.
69
70 #ifndef _FPDF_DEF_STR_
71 #define _FPDF_DEF_STR_
72 /** @brief Structure for byte string.
73   *
74   * @note In SDK, a byte string commonly means a UTF-16LE format string.
75   */
76 typedef struct _FPDF_BSTR
77 {
78         /** 
79          * @brief String buffer.
80          */
81         char*   str;
82         /**
83          * @brief       Length of a string, in bytes.
84          */
85         int     len;
86 } FPDF_BSTR;
87
88 #endif
89
90 // For Windows programmers: for most case it's OK to treat FPDF_WIDESTRING as Windows unicode string,
91 //               however, special care needs to be taken if you expect to process Unicode larger than 0xffff.
92 // For Linux/Unix programmers: most compiler/library environment uses 4 bytes for a Unicode character,
93 //              you have to convert between FPDF_WIDESTRING and system wide string by yourself.
94
95 #ifdef _WIN32_WCE
96 typedef const unsigned short* FPDF_STRING;
97 #else
98 typedef const char* FPDF_STRING;
99 #endif
100
101 #ifndef _FS_DEF_MATRIX_
102 #define _FS_DEF_MATRIX_
103 /** @brief Matrix for transformation. */
104 typedef struct _FS_MATRIX_
105 {
106         float   a;      /**< @brief Coefficient a.*/
107         float   b;      /**< @brief Coefficient b.*/
108         float   c;      /**< @brief Coefficient c.*/
109         float   d;      /**< @brief Coefficient d.*/
110         float   e;      /**< @brief Coefficient e.*/
111         float   f;      /**< @brief Coefficient f.*/
112 } FS_MATRIX;
113 #endif
114
115 #ifndef _FS_DEF_RECTF_
116 #define _FS_DEF_RECTF_
117 /** @brief Rectangle area(float) in device or page coordination system. */
118 typedef struct _FS_RECTF_
119 {
120         /**@{*/
121         /** @brief The x-coordinate of the left-top corner. */
122         float   left;
123         /** @brief The y-coordinate of the left-top corner. */
124         float   top;
125         /** @brief The x-coordinate of the right-bottom corner. */
126         float   right;
127         /** @brief The y-coordinate of the right-bottom corner. */
128         float   bottom;
129         /**@}*/
130 }* FS_LPRECTF, FS_RECTF;
131 /** @brief Const Pointer to ::FS_RECTF structure.*/
132 typedef const FS_RECTF* FS_LPCRECTF;
133 #endif
134
135 #if defined(_WIN32) && defined(FPDFSDK_EXPORTS)
136 // On Windows system, functions are exported in a DLL
137 #define DLLEXPORT __declspec( dllexport )
138 #define STDCALL __stdcall
139 #else
140 #define DLLEXPORT
141 #define STDCALL
142 #endif
143
144 extern const char g_ExpireDate[];
145 extern const char g_ModuleCodes[];
146
147 // Exported Functions
148 #ifdef __cplusplus
149 extern "C" {
150 #endif
151
152 // Function: FPDF_InitLibrary
153 //                      Initialize the FPDFSDK library 
154 // Parameters:
155 //                      hInstance       -       For WIN32 system only: the instance of the executable or DLL module.
156 // Return value:
157 //                      None.
158 // Comments:
159 //                      You have to call this function before you can call any PDF processing functions.
160
161 DLLEXPORT void STDCALL FPDF_InitLibrary(void* hInstance);
162
163
164 // Function: FPDF_DestroyLibary
165 //                      Release all resources allocated by the FPDFSDK library.
166 // Parameters:
167 //                      None.
168 // Return value:
169 //                      None.
170 // Comments:
171 //                      You can call this function to release all memory blocks allocated by the library. 
172 //                      After this function called, you should not call any PDF processing functions.
173 DLLEXPORT void STDCALL FPDF_DestroyLibrary();
174
175 //Policy for accessing the local machine time.
176 #define FPDF_POLICY_MACHINETIME_ACCESS  0
177
178 // Function: FPDF_SetSandBoxPolicy
179 //                      Set the policy for the sandbox environment.
180 // Parameters:  
181 //                      policy          -       The specified policy for setting, for example:FPDF_POLICY_MACHINETIME_ACCESS.
182 //                      enable          -       True for enable, False for disable the policy.
183 // Return value:
184 //                      None.
185 DLLEXPORT void  STDCALL FPDF_SetSandBoxPolicy(FPDF_DWORD policy, FPDF_BOOL enable);
186
187 /**
188 * Open and load a PDF document.
189 * @param[in] file_path  -       Path to the PDF file (including extension).
190 * @param[in] password   -       A string used as the password for PDF file. 
191 *                                                       If no password needed, empty or NULL can be used.
192 * @note         Loaded document can be closed by FPDF_CloseDocument.
193 *                       If this function fails, you can use FPDF_GetLastError() to retrieve
194 *                       the reason why it fails.
195 *                       The application should call ::FPDF_LoadXFA function after PDF document loaded 
196 *                       to support XFA fields in fpdfformfill.h file.
197 *
198 * @retval       A handle to the loaded document. If failed, NULL is returned.
199 */
200 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadDocument(FPDF_STRING file_path, 
201         FPDF_BYTESTRING password);
202
203 // Function: FPDF_LoadMemDocument
204 //                      Open and load a PDF document from memory.
205 // Parameters: 
206 //                      data_buf        -       Pointer to a buffer containing the PDF document.
207 //                      size            -       Number of bytes in the PDF document.
208 //                      password        -       A string used as the password for PDF file. 
209 //                                                      If no password needed, empty or NULL can be used.
210 // Return value:
211 //                      A handle to the loaded document. If failed, NULL is returned.
212 // Comments:
213 //                      The memory buffer must remain valid when the document is open.
214 //                      Loaded document can be closed by FPDF_CloseDocument.
215 //                      If this function fails, you can use FPDF_GetLastError() to retrieve
216 //                      the reason why it fails.
217 // Notes:
218 //                      The application should call ::FPDF_LoadXFA function after PDF document loaded 
219 //                      to support XFA fields in fpdfformfill.h file.
220 //
221 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadMemDocument(const void* data_buf, 
222                                                                                         int size, FPDF_BYTESTRING password);
223
224 // Structure for custom file access.
225 typedef struct {
226         // File length, in bytes.
227         unsigned long   m_FileLen;
228
229         // A function pointer for getting a block of data from specific position.
230         // Position is specified by byte offset from beginning of the file.
231         // The position and size will never go out range of file length.
232         // It may be possible for FPDFSDK to call this function multiple times for same position.
233         // Return value: should be non-zero if successful, zero for error.
234         int                             (*m_GetBlock)(void* param, unsigned long position, unsigned char* pBuf, unsigned long size);
235
236         // A custom pointer for all implementation specific data.
237         // This pointer will be used as the first parameter to m_GetBlock callback.
238         void*                   m_Param;
239 } FPDF_FILEACCESS;
240
241 /**
242  * @brief Structure for file reading or writing (I/O).
243  *
244  * @note This is a handler and should be implemented by callers.
245  */
246 typedef struct _FPDF_FILEHANDLER
247 {
248         /**
249          * @brief User-defined data.
250          * @note Callers can use this field to track controls.
251          */
252         FPDF_LPVOID     clientData;
253         /**
254          * @brief Callback function to release the current file stream object.
255          *
256          * @param[in] clientData        Pointer to user-defined data.
257          *
258          * @return None.
259          */
260         void            (*Release)(FPDF_LPVOID clientData);
261         /**
262          * @brief Callback function to retrieve the current file stream size.
263          *
264          * @param[in] clientData        Pointer to user-defined data.
265          *
266          * @return Size of file stream.
267          */
268         FPDF_DWORD      (*GetSize)(FPDF_LPVOID clientData);
269         /**
270          * @brief Callback function to read data from the current file stream.
271          *
272          * @param[in]   clientData      Pointer to user-defined data.
273          * @param[in]   offset          Offset position starts from the beginning of file stream. This parameter indicates reading position.
274          * @param[in]   buffer          Memory buffer to store data which are read from file stream. This parameter should not be <b>NULL</b>.
275          * @param[in]   size            Size of data which should be read from file stream, in bytes. The buffer indicated by the parameter <i>buffer</i> should be enough to store specified data.
276          * 
277          * @return 0 for success, other value for failure.
278          */
279         FPDF_RESULT     (*ReadBlock)(FPDF_LPVOID clientData, FPDF_DWORD offset, FPDF_LPVOID buffer, FPDF_DWORD size);
280         /**
281          * @brief       Callback function to write data into the current file stream.
282          *
283          * @param[in]   clientData      Pointer to user-defined data.
284          * @param[in]   offset          Offset position starts from the beginning of file stream. This parameter indicates writing position.
285          * @param[in]   buffer          Memory buffer contains data which is written into file stream. This parameter should not be <b>NULL</b>.
286          * @param[in]   size            Size of data which should be written into file stream, in bytes.
287          *
288          * @return 0 for success, other value for failure.
289          */
290         FPDF_RESULT     (*WriteBlock)(FPDF_LPVOID clientData, FPDF_DWORD offset, FPDF_LPCVOID buffer, FPDF_DWORD size);
291         /**
292          * @brief       Callback function to flush all internal accessing buffers.
293          *
294          * @param[in]   clientData      Pointer to user-defined data.
295          *
296          * @return 0 for success, other value for failure.
297          */
298         FPDF_RESULT     (*Flush)(FPDF_LPVOID clientData);
299         /**
300          * @brief       Callback function to change file size.
301          *
302          * @details     This function is called under writing mode usually. Implementer can determine whether to realize it based on application requests.
303          *
304          * @param[in]   clientData      Pointer to user-defined data.
305          * @param[in]   size            New size of file stream, in bytes.
306          *
307          * @return 0 for success, other value for failure.
308          */
309         FPDF_RESULT     (*Truncate)(FPDF_LPVOID clientData, FPDF_DWORD size);
310
311 } FPDF_FILEHANDLER, *FPDF_LPFILEHANDLER;
312
313 // Function: FPDF_LoadCustomDocument
314 //                      Load PDF document from a custom access descriptor.
315 // Parameters:
316 //                      pFileAccess     -       A structure for access the file.
317 //                      password        -       Optional password for decrypting the PDF file.
318 // Return value:
319 //                      A handle to the loaded document. If failed, NULL is returned.
320 // Comments:
321 //                      The application should maintain the file resources being valid until the PDF document close.
322 //                      Loaded document can be closed by FPDF_CloseDocument.
323 // Notes:
324 //                      The application should call ::FPDF_LoadXFA function after PDF document loaded 
325 //                      to support XFA fields in fpdfformfill.h file.
326 //
327 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadCustomDocument(FPDF_FILEACCESS* pFileAccess, 
328                                                                                                                 FPDF_BYTESTRING password);
329
330 // Function: FPDF_GetFileVersion
331 //                      Get the file version of the specific PDF document.
332 // Parameters:
333 //                      doc                     -       Handle to document.
334 //                      fileVersion     -       The PDF file version. File version: 14 for 1.4, 15 for 1.5, ...
335 // Return value:
336 //                      TRUE if this call succeed, If failed, FALSE is returned.
337 // Comments:
338 //                      If the document is created by function ::FPDF_CreateNewDocument, then this function would always fail.
339 //
340 DLLEXPORT FPDF_BOOL STDCALL FPDF_GetFileVersion(FPDF_DOCUMENT doc, int* fileVersion);
341
342 #define FPDF_ERR_SUCCESS                0               // No error.
343 #define FPDF_ERR_UNKNOWN                1               // Unknown error.
344 #define FPDF_ERR_FILE                   2               // File not found or could not be opened.
345 #define FPDF_ERR_FORMAT                 3               // File not in PDF format or corrupted.
346 #define FPDF_ERR_PASSWORD               4               // Password required or incorrect password.
347 #define FPDF_ERR_SECURITY               5               // Unsupported security scheme.
348 #define FPDF_ERR_PAGE                   6               // Page not found or content error.
349 #define FPDF_ERR_XFALOAD                7               // Load XFA error.
350 #define FPDF_ERR_XFALAYOUT              8       // Layout XFA error.
351
352 // Function: FPDF_GetLastError
353 //                      Get last error code when an SDK function failed.
354 // Parameters: 
355 //                      None.
356 // Return value:
357 //                      A 32-bit integer indicating error codes (defined above).
358 // Comments:
359 //                      If the previous SDK call succeeded, the return value of this function
360 //                      is not defined.
361 //
362 DLLEXPORT unsigned long STDCALL FPDF_GetLastError();
363
364 // Function: FPDF_GetDocPermission
365 //                      Get file permission flags of the document.
366 // Parameters: 
367 //                      document        -       Handle to document. Returned by FPDF_LoadDocument function.
368 // Return value:
369 //                      A 32-bit integer indicating permission flags. Please refer to PDF Reference for
370 //                      detailed description. If the document is not protected, 0xffffffff will be returned.
371 //
372 DLLEXPORT unsigned long STDCALL FPDF_GetDocPermissions(FPDF_DOCUMENT document);
373
374 // Function: FPDF_GetSecurityHandlerRevision
375 //                      Get the revision for security handler.
376 // Parameters:
377 //                      document        -       Handle to document. Returned by FPDF_LoadDocument function.
378 // Return value:
379 //                      The security handler revision number. Please refer to PDF Reference for
380 //                      detailed description. If the document is not protected, -1 will be returned.
381 //
382 DLLEXPORT int STDCALL FPDF_GetSecurityHandlerRevision(FPDF_DOCUMENT document);
383
384 // Function: FPDF_GetPageCount
385 //                      Get total number of pages in a document.
386 // Parameters: 
387 //                      document        -       Handle to document. Returned by FPDF_LoadDocument function.
388 // Return value:
389 //                      Total number of pages in the document.
390 //
391 DLLEXPORT int STDCALL FPDF_GetPageCount(FPDF_DOCUMENT document);
392
393 // Function: FPDF_LoadPage
394 //                      Load a page inside a document.
395 // Parameters: 
396 //                      document        -       Handle to document. Returned by FPDF_LoadDocument function.
397 //                      page_index      -       Index number of the page. 0 for the first page.
398 // Return value:
399 //                      A handle to the loaded page. If failed, NULL is returned.
400 // Comments:
401 //                      Loaded page can be rendered to devices using FPDF_RenderPage function.
402 //                      Loaded page can be closed by FPDF_ClosePage.
403 //
404 DLLEXPORT FPDF_PAGE     STDCALL FPDF_LoadPage(FPDF_DOCUMENT document, int page_index);
405
406 // Function: FPDF_GetPageWidth
407 //                      Get page width.
408 // Parameters:
409 //                      page            -       Handle to the page. Returned by FPDF_LoadPage function.
410 // Return value:
411 //                      Page width (excluding non-displayable area) measured in points.
412 //                      One point is 1/72 inch (around 0.3528 mm).
413 //
414 DLLEXPORT double STDCALL FPDF_GetPageWidth(FPDF_PAGE page);
415
416 // Function: FPDF_GetPageHeight
417 //                      Get page height.
418 // Parameters:
419 //                      page            -       Handle to the page. Returned by FPDF_LoadPage function.
420 // Return value:
421 //                      Page height (excluding non-displayable area) measured in points.
422 //                      One point is 1/72 inch (around 0.3528 mm)
423 //
424 DLLEXPORT double STDCALL FPDF_GetPageHeight(FPDF_PAGE page);
425
426 // Function: FPDF_GetPageSizeByIndex
427 //                      Get the size of a page by index.
428 // Parameters:
429 //                      document        -       Handle to document. Returned by FPDF_LoadDocument function.
430 //                      page_index      -       Page index, zero for the first page.
431 //                      width           -       Pointer to a double value receiving the page width (in points).
432 //                      height          -       Pointer to a double value receiving the page height (in points).
433 // Return value:
434 //                      Non-zero for success. 0 for error (document or page not found).
435 //
436 DLLEXPORT int STDCALL FPDF_GetPageSizeByIndex(FPDF_DOCUMENT document, int page_index, double* width, double* height);
437
438
439 // Page rendering flags. They can be combined with bit OR.
440 #define FPDF_ANNOT                      0x01            // Set if annotations are to be rendered.
441 #define FPDF_LCD_TEXT           0x02            // Set if using text rendering optimized for LCD display.
442 #define FPDF_NO_NATIVETEXT      0x04            // Don't use the native text output available on some platforms
443 #define FPDF_GRAYSCALE          0x08            // Grayscale output.
444 #define FPDF_DEBUG_INFO         0x80            // Set if you want to get some debug info. 
445                                                                                 // Please discuss with Foxit first if you need to collect debug info.
446 #define FPDF_NO_CATCH           0x100           // Set if you don't want to catch exception.
447 #define FPDF_RENDER_LIMITEDIMAGECACHE   0x200   // Limit image cache size. 
448 #define FPDF_RENDER_FORCEHALFTONE               0x400   // Always use halftone for image stretching.
449 #define FPDF_PRINTING           0x800   // Render for printing.
450 #define FPDF_REVERSE_BYTE_ORDER         0x10            //set whether render in a reverse Byte order, this flag only 
451                                                                                                 //enable when render to a bitmap.
452 #ifdef _WIN32
453 // Function: FPDF_RenderPage
454 //                      Render contents in a page to a device (screen, bitmap, or printer).
455 //                      This function is only supported on Windows system.
456 // Parameters: 
457 //                      dc                      -       Handle to device context.
458 //                      page            -       Handle to the page. Returned by FPDF_LoadPage function.
459 //                      start_x         -       Left pixel position of the display area in the device coordinate.
460 //                      start_y         -       Top pixel position of the display area in the device coordinate.
461 //                      size_x          -       Horizontal size (in pixels) for displaying the page.
462 //                      size_y          -       Vertical size (in pixels) for displaying the page.
463 //                      rotate          -       Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
464 //                                                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
465 //                      flags           -       0 for normal display, or combination of flags defined above.
466 // Return value:
467 //                      None.
468 // Notes:
469 //                      The method can not support to render the page for the document consists of dynamic XFA fields. 
470 //
471 DLLEXPORT void STDCALL FPDF_RenderPage(HDC dc, FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y,
472                                                 int rotate, int flags);
473 #endif
474
475 // Function: FPDF_RenderPageBitmap
476 //                      Render contents in a page to a device independent bitmap
477 // Parameters: 
478 //                      bitmap          -       Handle to the device independent bitmap (as the output buffer).
479 //                                                      Bitmap handle can be created by FPDFBitmap_Create function.
480 //                      page            -       Handle to the page. Returned by FPDF_LoadPage function.
481 //                      start_x         -       Left pixel position of the display area in the bitmap coordinate.
482 //                      start_y         -       Top pixel position of the display area in the bitmap coordinate.
483 //                      size_x          -       Horizontal size (in pixels) for displaying the page.
484 //                      size_y          -       Vertical size (in pixels) for displaying the page.
485 //                      rotate          -       Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
486 //                                                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
487 //                      flags           -       0 for normal display, or combination of flags defined above.
488 // Return value:
489 //                      None.
490 // Notes:
491 //                      The method can not support to render the page for the document consists of dynamic XFA fields. 
492 //
493 DLLEXPORT void STDCALL FPDF_RenderPageBitmap(FPDF_BITMAP bitmap, FPDF_PAGE page, int start_x, int start_y, 
494                                                 int size_x, int size_y, int rotate, int flags);
495
496 // Function: FPDF_ClosePage
497 //                      Close a loaded PDF page.
498 // Parameters: 
499 //                      page            -       Handle to the loaded page.
500 // Return value:
501 //                      None.
502 //
503 DLLEXPORT void STDCALL FPDF_ClosePage(FPDF_PAGE page);
504
505 // Function: FPDF_CloseDocument
506 //                      Close a loaded PDF document.
507 // Parameters: 
508 //                      document        -       Handle to the loaded document.
509 // Return value:
510 //                      None.
511 //
512 DLLEXPORT void STDCALL FPDF_CloseDocument(FPDF_DOCUMENT document);
513
514 // Function: FPDF_DeviceToPage
515 //                      Convert the screen coordinate of a point to page coordinate.
516 // Parameters:
517 //                      page            -       Handle to the page. Returned by FPDF_LoadPage function.
518 //                      start_x         -       Left pixel position of the display area in the device coordinate.
519 //                      start_y         -       Top pixel position of the display area in the device coordinate.
520 //                      size_x          -       Horizontal size (in pixels) for displaying the page.
521 //                      size_y          -       Vertical size (in pixels) for displaying the page.
522 //                      rotate          -       Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
523 //                                                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
524 //                      device_x        -       X value in device coordinate, for the point to be converted.
525 //                      device_y        -       Y value in device coordinate, for the point to be converted.
526 //                      page_x          -       A Pointer to a double receiving the converted X value in page coordinate.
527 //                      page_y          -       A Pointer to a double receiving the converted Y value in page coordinate.
528 // Return value:
529 //                      None.
530 // Comments:
531 //                      The page coordinate system has its origin at left-bottom corner of the page, with X axis goes along
532 //                      the bottom side to the right, and Y axis goes along the left side upward. NOTE: this coordinate system 
533 //                      can be altered when you zoom, scroll, or rotate a page, however, a point on the page should always have 
534 //                      the same coordinate values in the page coordinate system. 
535 //
536 //                      The device coordinate system is device dependent. For screen device, its origin is at left-top
537 //                      corner of the window. However this origin can be altered by Windows coordinate transformation
538 //                      utilities. You must make sure the start_x, start_y, size_x, size_y and rotate parameters have exactly
539 //                      same values as you used in FPDF_RenderPage() function call.
540 //
541 DLLEXPORT void STDCALL FPDF_DeviceToPage(FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y,
542                                                 int rotate, int device_x, int device_y, double* page_x, double* page_y);
543
544 // Function: FPDF_PageToDevice
545 //                      Convert the page coordinate of a point to screen coordinate.
546 // Parameters:
547 //                      page            -       Handle to the page. Returned by FPDF_LoadPage function.
548 //                      start_x         -       Left pixel position of the display area in the device coordinate.
549 //                      start_y         -       Top pixel position of the display area in the device coordinate.
550 //                      size_x          -       Horizontal size (in pixels) for displaying the page.
551 //                      size_y          -       Vertical size (in pixels) for displaying the page.
552 //                      rotate          -       Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
553 //                                                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
554 //                      page_x          -       X value in page coordinate, for the point to be converted.
555 //                      page_y          -       Y value in page coordinate, for the point to be converted.
556 //                      device_x        -       A pointer to an integer receiving the result X value in device coordinate.
557 //                      device_y        -       A pointer to an integer receiving the result Y value in device coordinate.
558 // Return value:
559 //                      None.
560 // Comments:
561 //                      See comments of FPDF_DeviceToPage() function.
562 //
563 DLLEXPORT void STDCALL FPDF_PageToDevice(FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y,
564                                                 int rotate, double page_x, double page_y, int* device_x, int* device_y);
565
566 // Function: FPDFBitmap_Create
567 //                      Create a Foxit Device Independent Bitmap (FXDIB).
568 // Parameters:
569 //                      width           -       Number of pixels in a horizontal line of the bitmap. Must be greater than 0.
570 //                      height          -       Number of pixels in a vertical line of the bitmap. Must be greater than 0.
571 //                      alpha           -       A flag indicating whether alpha channel is used. Non-zero for using alpha, zero for not using.
572 // Return value:
573 //                      The created bitmap handle, or NULL if parameter error or out of memory.
574 // Comments:
575 //                      An FXDIB always use 4 byte per pixel. The first byte of a pixel is always double word aligned.
576 //                      Each pixel contains red (R), green (G), blue (B) and optionally alpha (A) values.
577 //                      The byte order is BGRx (the last byte unused if no alpha channel) or BGRA.
578 //                      
579 //                      The pixels in a horizontal line (also called scan line) are stored side by side, with left most
580 //                      pixel stored first (with lower memory address). Each scan line uses width*4 bytes.
581 //
582 //                      Scan lines are stored one after another, with top most scan line stored first. There is no gap
583 //                      between adjacent scan lines.
584 //
585 //                      This function allocates enough memory for holding all pixels in the bitmap, but it doesn't 
586 //                      initialize the buffer. Applications can use FPDFBitmap_FillRect to fill the bitmap using any color.
587 DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_Create(int width, int height, int alpha);
588
589 // More DIB formats
590 #define FPDFBitmap_Gray         1               // Gray scale bitmap, one byte per pixel.
591 #define FPDFBitmap_BGR          2               // 3 bytes per pixel, byte order: blue, green, red.
592 #define FPDFBitmap_BGRx         3               // 4 bytes per pixel, byte order: blue, green, red, unused.
593 #define FPDFBitmap_BGRA         4               // 4 bytes per pixel, byte order: blue, green, red, alpha.
594
595 // Function: FPDFBitmap_CreateEx
596 //                      Create a Foxit Device Independent Bitmap (FXDIB)
597 // Parameters:
598 //                      width           -       Number of pixels in a horizontal line of the bitmap. Must be greater than 0.
599 //                      height          -       Number of pixels in a vertical line of the bitmap. Must be greater than 0.
600 //                      format          -       A number indicating for bitmap format, as defined above.
601 //                      first_scan      -       A pointer to the first byte of first scan line, for external buffer
602 //                                                      only. If this parameter is NULL, then the SDK will create its own buffer.
603 //                      stride          -       Number of bytes for each scan line, for external buffer only..
604 // Return value:
605 //                      The created bitmap handle, or NULL if parameter error or out of memory.
606 // Comments:
607 //                      Similar to FPDFBitmap_Create function, with more formats and external buffer supported. 
608 //                      Bitmap created by this function can be used in any place that a FPDF_BITMAP handle is 
609 //                      required. 
610 //
611 //                      If external scanline buffer is used, then the application should destroy the buffer
612 //                      by itself. FPDFBitmap_Destroy function will not destroy the buffer.
613 //
614 DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_CreateEx(int width, int height, int format, void* first_scan, int stride);
615
616 // Function: FPDFBitmap_FillRect
617 //                      Fill a rectangle area in an FXDIB.
618 // Parameters:
619 //                      bitmap          -       The handle to the bitmap. Returned by FPDFBitmap_Create function.
620 //                      left            -       The left side position. Starting from 0 at the left-most pixel.
621 //                      top                     -       The top side position. Starting from 0 at the top-most scan line.
622 //                      width           -       Number of pixels to be filled in each scan line.
623 //                      height          -       Number of scan lines to be filled.
624 //                      color           -       A 32-bit value specifing the color, in 8888 ARGB format.
625 // Return value:
626 //                      None.
627 // Comments:
628 //                      This function set the color and (optionally) alpha value in specified region of the bitmap.
629 //                      NOTE: If alpha channel is used, this function does NOT composite the background with the source color,
630 //                      instead the background will be replaced by the source color and alpha.
631 //                      If alpha channel is not used, the "alpha" parameter is ignored.
632 //
633 DLLEXPORT void STDCALL FPDFBitmap_FillRect(FPDF_BITMAP bitmap, int left, int top, int width, int height, FPDF_DWORD color);
634
635 // Function: FPDFBitmap_GetBuffer
636 //                      Get data buffer of an FXDIB
637 // Parameters:
638 //                      bitmap          -       Handle to the bitmap. Returned by FPDFBitmap_Create function.
639 // Return value:
640 //                      The pointer to the first byte of the bitmap buffer.
641 // Comments:
642 //                      The stride may be more than width * number of bytes per pixel
643 //                      Applications can use this function to get the bitmap buffer pointer, then manipulate any color
644 //                      and/or alpha values for any pixels in the bitmap.
645 DLLEXPORT void* STDCALL FPDFBitmap_GetBuffer(FPDF_BITMAP bitmap);
646
647 // Function: FPDFBitmap_GetWidth
648 //                      Get width of an FXDIB.
649 // Parameters:
650 //                      bitmap          -       Handle to the bitmap. Returned by FPDFBitmap_Create function.
651 // Return value:
652 //                      The number of pixels in a horizontal line of the bitmap.
653 DLLEXPORT int STDCALL FPDFBitmap_GetWidth(FPDF_BITMAP bitmap);
654
655 // Function: FPDFBitmap_GetHeight
656 //                      Get height of an FXDIB.
657 // Parameters:
658 //                      bitmap          -       Handle to the bitmap. Returned by FPDFBitmap_Create function.
659 // Return value:
660 //                      The number of pixels in a vertical line of the bitmap.
661 DLLEXPORT int STDCALL FPDFBitmap_GetHeight(FPDF_BITMAP bitmap);
662
663 // Function: FPDFBitmap_GetStride
664 //                      Get number of bytes for each scan line in the bitmap buffer.
665 // Parameters:
666 //                      bitmap          -       Handle to the bitmap. Returned by FPDFBitmap_Create function.
667 // Return value:
668 //                      The number of bytes for each scan line in the bitmap buffer.
669 // Comments:
670 //                      The stride may be more than width * number of bytes per pixel
671 DLLEXPORT int STDCALL FPDFBitmap_GetStride(FPDF_BITMAP bitmap);
672
673 // Function: FPDFBitmap_Destroy
674 //                      Destroy an FXDIB and release all related buffers. 
675 // Parameters:
676 //                      bitmap          -       Handle to the bitmap. Returned by FPDFBitmap_Create function.
677 // Return value:
678 //                      None.
679 // Comments:
680 //                      This function will not destroy any external buffer.
681 //
682 DLLEXPORT void STDCALL FPDFBitmap_Destroy(FPDF_BITMAP bitmap);
683
684 // Function: FPDF_VIEWERREF_GetPrintScaling
685 //                      Whether the PDF document prefers to be scaled or not.
686 // Parameters: 
687 //                      document        -       Handle to the loaded document.
688 // Return value:
689 //                      None.
690 //
691 DLLEXPORT FPDF_BOOL STDCALL FPDF_VIEWERREF_GetPrintScaling(FPDF_DOCUMENT document);
692
693 // Function: FPDF_VIEWERREF_GetNumCopies
694 //                      Returns the number of copies to be printed.
695 // Parameters:
696 //                      document        -       Handle to the loaded document.
697 // Return value:
698 //          The number of copies to be printed.
699 //
700 DLLEXPORT int STDCALL FPDF_VIEWERREF_GetNumCopies(FPDF_DOCUMENT document);
701
702 // Function: FPDF_VIEWERREF_GetPrintPageRange
703 //                      Page numbers to initialize print dialog box when file is printed.
704 // Parameters:
705 //                      document        -       Handle to the loaded document.
706 // Return value:
707 //          The print page range to be used for printing.
708 //
709 DLLEXPORT FPDF_PAGERANGE STDCALL FPDF_VIEWERREF_GetPrintPageRange(FPDF_DOCUMENT document);
710
711 // Function: FPDF_VIEWERREF_GetDuplex
712 //                      Returns the paper handling option to be used when printing from print dialog.
713 // Parameters:
714 //                      document        -       Handle to the loaded document.
715 // Return value:
716 //          The paper handling option to be used when printing.
717 //
718 DLLEXPORT FPDF_DUPLEXTYPE STDCALL FPDF_VIEWERREF_GetDuplex(FPDF_DOCUMENT document);
719
720 // Function: FPDF_GetNamedDestByName
721 //                      get a special dest handle by the index.
722 // Parameters: 
723 //                      document        -       Handle to the loaded document.
724 //                      name            -       The name of a special named dest.
725 // Return value:
726 //                      The handle of the dest.
727 //
728 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDestByName(FPDF_DOCUMENT document,FPDF_BYTESTRING name);
729
730 // Function: FPDF_BStr_Init     
731 //                      Helper function to initialize a byte string.
732 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Init(FPDF_BSTR* str);
733
734 // Function: FPDF_BStr_Set      
735 //                      Helper function to set string data.
736 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Set(FPDF_BSTR* str, FPDF_LPCSTR bstr, int length);
737
738 // Function: FPDF_BStr_Clear    
739 //                      Helper function to clear a byte string.
740 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Clear(FPDF_BSTR* str);
741
742 #ifdef __cplusplus
743 };
744 #endif
745
746 #endif // _FPDFVIEW_H_