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