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 // 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 encoded), and platform dependent string
58 typedef const char* FPDF_BYTESTRING;
59
60 typedef const unsigned short* FPDF_WIDESTRING;        // Foxit PDF SDK always use UTF-16LE encoding wide string,
61                                                       // each character use 2 bytes (except surrogation), with low byte first.
62
63 // For Windows programmers: for most case it's OK to treat FPDF_WIDESTRING as Windows unicode string,
64 //       however, special care needs to be taken if you expect to process Unicode larger than 0xffff.
65 // For Linux/Unix programmers: most compiler/library environment uses 4 bytes for a Unicode character,
66 //      you have to convert between FPDF_WIDESTRING and system wide string by yourself.
67
68 #ifdef _WIN32_WCE
69 typedef const unsigned short* FPDF_STRING;
70 #else
71 typedef const char* FPDF_STRING;
72 #endif
73
74 #ifndef _FS_DEF_MATRIX_
75 #define _FS_DEF_MATRIX_
76 /** @brief Matrix for transformation. */
77 typedef struct _FS_MATRIX_
78 {
79     float   a;  /**< @brief Coefficient a.*/
80     float   b;  /**< @brief Coefficient b.*/
81     float   c;  /**< @brief Coefficient c.*/
82     float   d;  /**< @brief Coefficient d.*/
83     float   e;  /**< @brief Coefficient e.*/
84     float   f;  /**< @brief Coefficient f.*/
85 } FS_MATRIX;
86 #endif
87
88 #ifndef _FS_DEF_RECTF_
89 #define _FS_DEF_RECTF_
90 /** @brief Rectangle area(float) in device or page coordination system. */
91 typedef struct _FS_RECTF_
92 {
93     /**@{*/
94     /** @brief The x-coordinate of the left-top corner. */
95     float   left;
96     /** @brief The y-coordinate of the left-top corner. */
97     float   top;
98     /** @brief The x-coordinate of the right-bottom corner. */
99     float   right;
100     /** @brief The y-coordinate of the right-bottom corner. */
101     float   bottom;
102     /**@}*/
103 }* FS_LPRECTF, FS_RECTF;
104 /** @brief Const Pointer to ::FS_RECTF structure.*/
105 typedef const FS_RECTF* FS_LPCRECTF;
106 #endif
107
108 #if defined(_WIN32) && defined(FPDFSDK_EXPORTS)
109 // On Windows system, functions are exported in a DLL
110 #define DLLEXPORT __declspec( dllexport )
111 #define STDCALL __stdcall
112 #else
113 #define DLLEXPORT
114 #define STDCALL
115 #endif
116
117 extern const char g_ExpireDate[];
118 extern const char g_ModuleCodes[];
119
120 // Exported Functions
121 #ifdef __cplusplus
122 extern "C" {
123 #endif
124
125 // Function: FPDF_InitLibrary
126 //          Initialize the FPDFSDK library
127 // Parameters:
128 //          None
129 // Return value:
130 //          None.
131 // Comments:
132 //          You have to call this function before you can call any PDF processing functions.
133
134 DLLEXPORT void STDCALL FPDF_InitLibrary();
135
136
137 // Function: FPDF_DestroyLibary
138 //          Release all resources allocated by the FPDFSDK library.
139 // Parameters:
140 //          None.
141 // Return value:
142 //          None.
143 // Comments:
144 //          You can call this function to release all memory blocks allocated by the library.
145 //          After this function called, you should not call any PDF processing functions.
146 DLLEXPORT void STDCALL FPDF_DestroyLibrary();
147
148 //Policy for accessing the local machine time.
149 #define FPDF_POLICY_MACHINETIME_ACCESS  0
150
151 // Function: FPDF_SetSandBoxPolicy
152 //          Set the policy for the sandbox environment.
153 // Parameters:
154 //          policy      -   The specified policy for setting, for example:FPDF_POLICY_MACHINETIME_ACCESS.
155 //          enable      -   True for enable, False for disable the policy.
156 // Return value:
157 //          None.
158 DLLEXPORT void  STDCALL FPDF_SetSandBoxPolicy(FPDF_DWORD policy, FPDF_BOOL enable);
159
160 /**
161 * Open and load a PDF document.
162 * @param[in] file_path  -   Path to the PDF file (including extension).
163 * @param[in] password   -   A string used as the password for PDF file.
164 *                           If no password needed, empty or NULL can be used.
165 * @note     Loaded document can be closed by FPDF_CloseDocument.
166 *           If this function fails, you can use FPDF_GetLastError() to retrieve
167 *           the reason why it fails.
168 * @retval   A handle to the loaded document. If failed, NULL is returned.
169 */
170 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadDocument(FPDF_STRING file_path,
171     FPDF_BYTESTRING password);
172
173 // Function: FPDF_LoadMemDocument
174 //          Open and load a PDF document from memory.
175 // Parameters:
176 //          data_buf    -   Pointer to a buffer containing the PDF document.
177 //          size        -   Number of bytes in the PDF document.
178 //          password    -   A string used as the password for PDF file.
179 //                          If no password needed, empty or NULL can be used.
180 // Return value:
181 //          A handle to the loaded document. If failed, NULL is returned.
182 // Comments:
183 //          The memory buffer must remain valid when the document is open.
184 //          Loaded document can be closed by FPDF_CloseDocument.
185 //          If this function fails, you can use FPDF_GetLastError() to retrieve
186 //          the reason why it fails.
187 //
188 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadMemDocument(const void* data_buf,
189                                             int size, FPDF_BYTESTRING password);
190
191 // Structure for custom file access.
192 typedef struct {
193     // File length, in bytes.
194     unsigned long   m_FileLen;
195
196     // A function pointer for getting a block of data from specific position.
197     // Position is specified by byte offset from beginning of the file.
198     // The position and size will never go out range of file length.
199     // It may be possible for FPDFSDK to call this function multiple times for same position.
200     // Return value: should be non-zero if successful, zero for error.
201     int             (*m_GetBlock)(void* param, unsigned long position, unsigned char* pBuf, unsigned long size);
202
203     // A custom pointer for all implementation specific data.
204     // This pointer will be used as the first parameter to m_GetBlock callback.
205     void*           m_Param;
206 } FPDF_FILEACCESS;
207
208 // Function: FPDF_LoadCustomDocument
209 //          Load PDF document from a custom access descriptor.
210 // Parameters:
211 //          pFileAccess -   A structure for access the file.
212 //          password    -   Optional password for decrypting the PDF file.
213 // Return value:
214 //          A handle to the loaded document. If failed, NULL is returned.
215 // Comments:
216 //          The application should maintain the file resources being valid until the PDF document close.
217 //          Loaded document can be closed by FPDF_CloseDocument.
218 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadCustomDocument(FPDF_FILEACCESS* pFileAccess,
219                                                         FPDF_BYTESTRING password);
220
221 // Function: FPDF_GetFileVersion
222 //          Get the file version of the specific PDF document.
223 // Parameters:
224 //          doc         -   Handle to document.
225 //          fileVersion -   The PDF file version. File version: 14 for 1.4, 15 for 1.5, ...
226 // Return value:
227 //          TRUE if this call succeed, If failed, FALSE is returned.
228 // Comments:
229 //          If the document is created by function ::FPDF_CreateNewDocument, then this function would always fail.
230 DLLEXPORT FPDF_BOOL STDCALL FPDF_GetFileVersion(FPDF_DOCUMENT doc, int* fileVersion);
231
232 #define FPDF_ERR_SUCCESS        0       // No error.
233 #define FPDF_ERR_UNKNOWN        1       // Unknown error.
234 #define FPDF_ERR_FILE           2       // File not found or could not be opened.
235 #define FPDF_ERR_FORMAT         3       // File not in PDF format or corrupted.
236 #define FPDF_ERR_PASSWORD       4       // Password required or incorrect password.
237 #define FPDF_ERR_SECURITY       5       // Unsupported security scheme.
238 #define FPDF_ERR_PAGE           6       // Page not found or content error.
239
240 // Function: FPDF_GetLastError
241 //          Get last error code when an SDK function failed.
242 // Parameters:
243 //          None.
244 // Return value:
245 //          A 32-bit integer indicating error codes (defined above).
246 // Comments:
247 //          If the previous SDK call succeeded, the return value of this function
248 //          is not defined.
249 //
250 DLLEXPORT unsigned long STDCALL FPDF_GetLastError();
251
252 // Function: FPDF_GetDocPermission
253 //          Get file permission flags of the document.
254 // Parameters:
255 //          document    -   Handle to document. Returned by FPDF_LoadDocument function.
256 // Return value:
257 //          A 32-bit integer indicating permission flags. Please refer to PDF Reference for
258 //          detailed description. If the document is not protected, 0xffffffff will be returned.
259 //
260 DLLEXPORT unsigned long STDCALL FPDF_GetDocPermissions(FPDF_DOCUMENT document);
261
262 // Function: FPDF_GetSecurityHandlerRevision
263 //          Get the revision for security handler.
264 // Parameters:
265 //          document    -   Handle to document. Returned by FPDF_LoadDocument function.
266 // Return value:
267 //          The security handler revision number. Please refer to PDF Reference for
268 //          detailed description. If the document is not protected, -1 will be returned.
269 //
270 DLLEXPORT int STDCALL FPDF_GetSecurityHandlerRevision(FPDF_DOCUMENT document);
271
272 // Function: FPDF_GetPageCount
273 //          Get total number of pages in a document.
274 // Parameters:
275 //          document    -   Handle to document. Returned by FPDF_LoadDocument function.
276 // Return value:
277 //          Total number of pages in the document.
278 //
279 DLLEXPORT int STDCALL FPDF_GetPageCount(FPDF_DOCUMENT document);
280
281 // Function: FPDF_LoadPage
282 //          Load a page inside a document.
283 // Parameters:
284 //          document    -   Handle to document. Returned by FPDF_LoadDocument function.
285 //          page_index  -   Index number of the page. 0 for the first page.
286 // Return value:
287 //          A handle to the loaded page. If failed, NULL is returned.
288 // Comments:
289 //          Loaded page can be rendered to devices using FPDF_RenderPage function.
290 //          Loaded page can be closed by FPDF_ClosePage.
291 //
292 DLLEXPORT FPDF_PAGE STDCALL FPDF_LoadPage(FPDF_DOCUMENT document, int page_index);
293
294 // Function: FPDF_GetPageWidth
295 //          Get page width.
296 // Parameters:
297 //          page        -   Handle to the page. Returned by FPDF_LoadPage function.
298 // Return value:
299 //          Page width (excluding non-displayable area) measured in points.
300 //          One point is 1/72 inch (around 0.3528 mm).
301 //
302 DLLEXPORT double STDCALL FPDF_GetPageWidth(FPDF_PAGE page);
303
304 // Function: FPDF_GetPageHeight
305 //          Get page height.
306 // Parameters:
307 //          page        -   Handle to the page. Returned by FPDF_LoadPage function.
308 // Return value:
309 //          Page height (excluding non-displayable area) measured in points.
310 //          One point is 1/72 inch (around 0.3528 mm)
311 //
312 DLLEXPORT double STDCALL FPDF_GetPageHeight(FPDF_PAGE page);
313
314 // Function: FPDF_GetPageSizeByIndex
315 //          Get the size of a page by index.
316 // Parameters:
317 //          document    -   Handle to document. Returned by FPDF_LoadDocument function.
318 //          page_index  -   Page index, zero for the first page.
319 //          width       -   Pointer to a double value receiving the page width (in points).
320 //          height      -   Pointer to a double value receiving the page height (in points).
321 // Return value:
322 //          Non-zero for success. 0 for error (document or page not found).
323 //
324 DLLEXPORT int STDCALL FPDF_GetPageSizeByIndex(FPDF_DOCUMENT document, int page_index, double* width, double* height);
325
326
327 // Page rendering flags. They can be combined with bit OR.
328 #define FPDF_ANNOT          0x01        // Set if annotations are to be rendered.
329 #define FPDF_LCD_TEXT       0x02        // Set if using text rendering optimized for LCD display.
330 #define FPDF_NO_NATIVETEXT  0x04        // Don't use the native text output available on some platforms
331 #define FPDF_GRAYSCALE      0x08        // Grayscale output.
332 #define FPDF_DEBUG_INFO     0x80        // Set if you want to get some debug info.
333                                         // Please discuss with Foxit first if you need to collect debug info.
334 #define FPDF_NO_CATCH       0x100       // Set if you don't want to catch exception.
335 #define FPDF_RENDER_LIMITEDIMAGECACHE   0x200   // Limit image cache size.
336 #define FPDF_RENDER_FORCEHALFTONE       0x400   // Always use halftone for image stretching.
337 #define FPDF_PRINTING       0x800   // Render for printing.
338 #define FPDF_RENDER_NO_SMOOTHTEXT   0x1000  // Set to disable anti-aliasing on text.
339 #define FPDF_RENDER_NO_SMOOTHIMAGE  0x2000  // Set to disable anti-aliasing on images.
340 #define FPDF_RENDER_NO_SMOOTHPATH   0x4000  // Set to disable anti-aliasing on paths.
341 #define FPDF_REVERSE_BYTE_ORDER     0x10        //set whether render in a reverse Byte order, this flag only
342                                                 //enable when render to a bitmap.
343 #ifdef _WIN32
344 // Function: FPDF_RenderPage
345 //          Render contents in a page to a device (screen, bitmap, or printer).
346 //          This function is only supported on Windows system.
347 // Parameters:
348 //          dc          -   Handle to device context.
349 //          page        -   Handle to the page. Returned by FPDF_LoadPage function.
350 //          start_x     -   Left pixel position of the display area in the device coordinate.
351 //          start_y     -   Top pixel position of the display area in the device coordinate.
352 //          size_x      -   Horizontal size (in pixels) for displaying the page.
353 //          size_y      -   Vertical size (in pixels) for displaying the page.
354 //          rotate      -   Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
355 //                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
356 //          flags       -   0 for normal display, or combination of flags defined above.
357 // Return value:
358 //          None.
359 //
360 DLLEXPORT void STDCALL FPDF_RenderPage(HDC dc, FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y,
361                         int rotate, int flags);
362 #endif
363
364 // Function: FPDF_RenderPageBitmap
365 //          Render contents in a page to a device independent bitmap
366 // Parameters:
367 //          bitmap      -   Handle to the device independent bitmap (as the output buffer).
368 //                          Bitmap handle can be created by FPDFBitmap_Create function.
369 //          page        -   Handle to the page. Returned by FPDF_LoadPage function.
370 //          start_x     -   Left pixel position of the display area in the bitmap coordinate.
371 //          start_y     -   Top pixel position of the display area in the bitmap coordinate.
372 //          size_x      -   Horizontal size (in pixels) for displaying the page.
373 //          size_y      -   Vertical size (in pixels) for displaying the page.
374 //          rotate      -   Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
375 //                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
376 //          flags       -   0 for normal display, or combination of flags defined above.
377 // Return value:
378 //          None.
379 //
380 DLLEXPORT void STDCALL FPDF_RenderPageBitmap(FPDF_BITMAP bitmap, FPDF_PAGE page, int start_x, int start_y,
381                         int size_x, int size_y, int rotate, int flags);
382
383 // Function: FPDF_ClosePage
384 //          Close a loaded PDF page.
385 // Parameters:
386 //          page        -   Handle to the loaded page.
387 // Return value:
388 //          None.
389 //
390 DLLEXPORT void STDCALL FPDF_ClosePage(FPDF_PAGE page);
391
392 // Function: FPDF_CloseDocument
393 //          Close a loaded PDF document.
394 // Parameters:
395 //          document    -   Handle to the loaded document.
396 // Return value:
397 //          None.
398 //
399 DLLEXPORT void STDCALL FPDF_CloseDocument(FPDF_DOCUMENT document);
400
401 // Function: FPDF_DeviceToPage
402 //          Convert the screen coordinate of a point to page coordinate.
403 // Parameters:
404 //          page        -   Handle to the page. Returned by FPDF_LoadPage function.
405 //          start_x     -   Left pixel position of the display area in the device coordinate.
406 //          start_y     -   Top pixel position of the display area in the device coordinate.
407 //          size_x      -   Horizontal size (in pixels) for displaying the page.
408 //          size_y      -   Vertical size (in pixels) for displaying the page.
409 //          rotate      -   Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
410 //                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
411 //          device_x    -   X value in device coordinate, for the point to be converted.
412 //          device_y    -   Y value in device coordinate, for the point to be converted.
413 //          page_x      -   A Pointer to a double receiving the converted X value in page coordinate.
414 //          page_y      -   A Pointer to a double receiving the converted Y value in page coordinate.
415 // Return value:
416 //          None.
417 // Comments:
418 //          The page coordinate system has its origin at left-bottom corner of the page, with X axis goes along
419 //          the bottom side to the right, and Y axis goes along the left side upward. NOTE: this coordinate system
420 //          can be altered when you zoom, scroll, or rotate a page, however, a point on the page should always have
421 //          the same coordinate values in the page coordinate system.
422 //
423 //          The device coordinate system is device dependent. For screen device, its origin is at left-top
424 //          corner of the window. However this origin can be altered by Windows coordinate transformation
425 //          utilities. You must make sure the start_x, start_y, size_x, size_y and rotate parameters have exactly
426 //          same values as you used in FPDF_RenderPage() function call.
427 //
428 DLLEXPORT void STDCALL FPDF_DeviceToPage(FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y,
429                         int rotate, int device_x, int device_y, double* page_x, double* page_y);
430
431 // Function: FPDF_PageToDevice
432 //          Convert the page coordinate of a point to screen coordinate.
433 // Parameters:
434 //          page        -   Handle to the page. Returned by FPDF_LoadPage function.
435 //          start_x     -   Left pixel position of the display area in the device coordinate.
436 //          start_y     -   Top pixel position of the display area in the device coordinate.
437 //          size_x      -   Horizontal size (in pixels) for displaying the page.
438 //          size_y      -   Vertical size (in pixels) for displaying the page.
439 //          rotate      -   Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise),
440 //                              2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
441 //          page_x      -   X value in page coordinate, for the point to be converted.
442 //          page_y      -   Y value in page coordinate, for the point to be converted.
443 //          device_x    -   A pointer to an integer receiving the result X value in device coordinate.
444 //          device_y    -   A pointer to an integer receiving the result Y value in device coordinate.
445 // Return value:
446 //          None.
447 // Comments:
448 //          See comments of FPDF_DeviceToPage() function.
449 //
450 DLLEXPORT void STDCALL FPDF_PageToDevice(FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y,
451                         int rotate, double page_x, double page_y, int* device_x, int* device_y);
452
453 // Function: FPDFBitmap_Create
454 //          Create a Foxit Device Independent Bitmap (FXDIB).
455 // Parameters:
456 //          width       -   Number of pixels in a horizontal line of the bitmap. Must be greater than 0.
457 //          height      -   Number of pixels in a vertical line of the bitmap. Must be greater than 0.
458 //          alpha       -   A flag indicating whether alpha channel is used. Non-zero for using alpha, zero for not using.
459 // Return value:
460 //          The created bitmap handle, or NULL if parameter error or out of memory.
461 // Comments:
462 //          An FXDIB always use 4 byte per pixel. The first byte of a pixel is always double word aligned.
463 //          Each pixel contains red (R), green (G), blue (B) and optionally alpha (A) values.
464 //          The byte order is BGRx (the last byte unused if no alpha channel) or BGRA.
465 //
466 //          The pixels in a horizontal line (also called scan line) are stored side by side, with left most
467 //          pixel stored first (with lower memory address). Each scan line uses width*4 bytes.
468 //
469 //          Scan lines are stored one after another, with top most scan line stored first. There is no gap
470 //          between adjacent scan lines.
471 //
472 //          This function allocates enough memory for holding all pixels in the bitmap, but it doesn't
473 //          initialize the buffer. Applications can use FPDFBitmap_FillRect to fill the bitmap using any color.
474 DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_Create(int width, int height, int alpha);
475
476 // More DIB formats
477 #define FPDFBitmap_Gray     1       // Gray scale bitmap, one byte per pixel.
478 #define FPDFBitmap_BGR      2       // 3 bytes per pixel, byte order: blue, green, red.
479 #define FPDFBitmap_BGRx     3       // 4 bytes per pixel, byte order: blue, green, red, unused.
480 #define FPDFBitmap_BGRA     4       // 4 bytes per pixel, byte order: blue, green, red, alpha.
481
482 // Function: FPDFBitmap_CreateEx
483 //          Create a Foxit Device Independent Bitmap (FXDIB)
484 // Parameters:
485 //          width       -   Number of pixels in a horizontal line of the bitmap. Must be greater than 0.
486 //          height      -   Number of pixels in a vertical line of the bitmap. Must be greater than 0.
487 //          format      -   A number indicating for bitmap format, as defined above.
488 //          first_scan  -   A pointer to the first byte of first scan line, for external buffer
489 //                          only. If this parameter is NULL, then the SDK will create its own buffer.
490 //          stride      -   Number of bytes for each scan line, for external buffer only..
491 // Return value:
492 //          The created bitmap handle, or NULL if parameter error or out of memory.
493 // Comments:
494 //          Similar to FPDFBitmap_Create function, with more formats and external buffer supported.
495 //          Bitmap created by this function can be used in any place that a FPDF_BITMAP handle is
496 //          required.
497 //
498 //          If external scanline buffer is used, then the application should destroy the buffer
499 //          by itself. FPDFBitmap_Destroy function will not destroy the buffer.
500 //
501 DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_CreateEx(int width, int height, int format, void* first_scan, int stride);
502
503 // Function: FPDFBitmap_FillRect
504 //          Fill a rectangle area in an FXDIB.
505 // Parameters:
506 //          bitmap      -   The handle to the bitmap. Returned by FPDFBitmap_Create function.
507 //          left        -   The left side position. Starting from 0 at the left-most pixel.
508 //          top         -   The top side position. Starting from 0 at the top-most scan line.
509 //          width       -   Number of pixels to be filled in each scan line.
510 //          height      -   Number of scan lines to be filled.
511 //          color       -   A 32-bit value specifing the color, in 8888 ARGB format.
512 // Return value:
513 //          None.
514 // Comments:
515 //          This function set the color and (optionally) alpha value in specified region of the bitmap.
516 //          NOTE: If alpha channel is used, this function does NOT composite the background with the source color,
517 //          instead the background will be replaced by the source color and alpha.
518 //          If alpha channel is not used, the "alpha" parameter is ignored.
519 //
520 DLLEXPORT void STDCALL FPDFBitmap_FillRect(FPDF_BITMAP bitmap, int left, int top, int width, int height, FPDF_DWORD color);
521
522 // Function: FPDFBitmap_GetBuffer
523 //          Get data buffer of an FXDIB
524 // Parameters:
525 //          bitmap      -   Handle to the bitmap. Returned by FPDFBitmap_Create function.
526 // Return value:
527 //          The pointer to the first byte of the bitmap buffer.
528 // Comments:
529 //          The stride may be more than width * number of bytes per pixel
530 //          Applications can use this function to get the bitmap buffer pointer, then manipulate any color
531 //          and/or alpha values for any pixels in the bitmap.
532 DLLEXPORT void* STDCALL FPDFBitmap_GetBuffer(FPDF_BITMAP bitmap);
533
534 // Function: FPDFBitmap_GetWidth
535 //          Get width of an FXDIB.
536 // Parameters:
537 //          bitmap      -   Handle to the bitmap. Returned by FPDFBitmap_Create function.
538 // Return value:
539 //          The number of pixels in a horizontal line of the bitmap.
540 DLLEXPORT int STDCALL FPDFBitmap_GetWidth(FPDF_BITMAP bitmap);
541
542 // Function: FPDFBitmap_GetHeight
543 //          Get height of an FXDIB.
544 // Parameters:
545 //          bitmap      -   Handle to the bitmap. Returned by FPDFBitmap_Create function.
546 // Return value:
547 //          The number of pixels in a vertical line of the bitmap.
548 DLLEXPORT int STDCALL FPDFBitmap_GetHeight(FPDF_BITMAP bitmap);
549
550 // Function: FPDFBitmap_GetStride
551 //          Get number of bytes for each scan line in the bitmap buffer.
552 // Parameters:
553 //          bitmap      -   Handle to the bitmap. Returned by FPDFBitmap_Create function.
554 // Return value:
555 //          The number of bytes for each scan line in the bitmap buffer.
556 // Comments:
557 //          The stride may be more than width * number of bytes per pixel
558 DLLEXPORT int STDCALL FPDFBitmap_GetStride(FPDF_BITMAP bitmap);
559
560 // Function: FPDFBitmap_Destroy
561 //          Destroy an FXDIB and release all related buffers.
562 // Parameters:
563 //          bitmap      -   Handle to the bitmap. Returned by FPDFBitmap_Create function.
564 // Return value:
565 //          None.
566 // Comments:
567 //          This function will not destroy any external buffer.
568 //
569 DLLEXPORT void STDCALL FPDFBitmap_Destroy(FPDF_BITMAP bitmap);
570
571 // Function: FPDF_VIEWERREF_GetPrintScaling
572 //          Whether the PDF document prefers to be scaled or not.
573 // Parameters:
574 //          document    -   Handle to the loaded document.
575 // Return value:
576 //          None.
577 //
578 DLLEXPORT FPDF_BOOL STDCALL FPDF_VIEWERREF_GetPrintScaling(FPDF_DOCUMENT document);
579
580 // Function: FPDF_VIEWERREF_GetNumCopies
581 //          Returns the number of copies to be printed.
582 // Parameters:
583 //          document    -   Handle to the loaded document.
584 // Return value:
585 //          The number of copies to be printed.
586 //
587 DLLEXPORT int STDCALL FPDF_VIEWERREF_GetNumCopies(FPDF_DOCUMENT document);
588
589 // Function: FPDF_VIEWERREF_GetPrintPageRange
590 //          Page numbers to initialize print dialog box when file is printed.
591 // Parameters:
592 //          document    -   Handle to the loaded document.
593 // Return value:
594 //          The print page range to be used for printing.
595 //
596 DLLEXPORT FPDF_PAGERANGE STDCALL FPDF_VIEWERREF_GetPrintPageRange(FPDF_DOCUMENT document);
597
598 // Function: FPDF_VIEWERREF_GetDuplex
599 //          Returns the paper handling option to be used when printing from print dialog.
600 // Parameters:
601 //          document    -   Handle to the loaded document.
602 // Return value:
603 //          The paper handling option to be used when printing.
604 //
605 DLLEXPORT FPDF_DUPLEXTYPE STDCALL FPDF_VIEWERREF_GetDuplex(FPDF_DOCUMENT document);
606
607 // Function: FPDF_CountNamedDests
608 //          Get the count of named destinations in the PDF document.
609 // Parameters:
610 //          document    -   Handle to a document
611 // Return value:
612 //          The count of named destinations.
613 DLLEXPORT FPDF_DWORD STDCALL FPDF_CountNamedDests(FPDF_DOCUMENT document);
614
615 // Function: FPDF_GetNamedDestByName
616 //          get a special dest handle by the index.
617 // Parameters:
618 //          document    -   Handle to the loaded document.
619 //          name        -   The name of a special named dest.
620 // Return value:
621 //          The handle of the dest.
622 //
623 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDestByName(FPDF_DOCUMENT document, FPDF_BYTESTRING name);
624
625 // Function: FPDF_GetNamedDest
626 //          Get the specified named destinations of the PDF document by index.
627 // Parameters:
628 //          document        -   Handle to a document
629 //          index           -   The index of named destination.
630 //          buffer          -   The buffer to obtain destination name, used as wchar_t*.
631 //          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.
632 // Return value:
633 //          The destination handle of a named destination, or NULL if no named destination corresponding to |index|.
634 // Comments:
635 //          Call this function twice to get the name of the named destination:
636 //          1) First time pass in |buffer| as NULL and get buflen.
637 //          2) Second time pass in allocated |buffer| and buflen to retrieve |buffer|, which should be used as wchar_t*.
638 //             If buflen is not sufficiently large, it will be set to -1 upon return.
639 //
640 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDest(FPDF_DOCUMENT document, int index, void* buffer, long* buflen);
641
642 #ifdef __cplusplus
643 }
644 #endif
645
646 #endif  // PUBLIC_FPDFVIEW_H_