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