Make (and verify) public/ files compile under C.
[pdfium.git] / public / fpdf_transformpage.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 #ifndef _TRANSFORMPAGE_H_
8 #define _TRANSFORMPAGE_H_
9
10 #ifndef _FPDFVIEW_H_
11 #include "fpdfview.h"
12 #endif
13
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17
18 typedef void* FPDF_PAGEARCSAVER;
19 typedef void* FPDF_PAGEARCLOADER;
20 /**
21 *  Set "MediaBox" entry to the page dictionary.                                            
22 * @param[in] page       - Handle to a page.
23 * @param[in] left       - The left of the rectangle.
24 * @param[in] bottom     - The bottom of the rectangle.
25 * @param[in] right      - The right of the rectangle.
26 * @param[in] top        - The top of the rectangle.
27 * @retval None.
28 */
29 DLLEXPORT void STDCALL FPDFPage_SetMediaBox(FPDF_PAGE page, float left, float bottom, float right, float top);
30
31 /**
32 *  Set "CropBox" entry to the page dictionary.                                             
33 * @param[in] page       - Handle to a page.
34 * @param[in] left       - The left of the rectangle.
35 * @param[in] bottom     - The bottom of the rectangle.
36 * @param[in] right      - The right of the rectangle.
37 * @param[in] top        - The top of the rectangle.
38 * @retval None.
39 */
40 DLLEXPORT void STDCALL FPDFPage_SetCropBox(FPDF_PAGE page, float left, float bottom, float right, float top);
41
42
43 /**  Get "MediaBox" entry from the page dictionary.                                                
44 * @param[in] page       - Handle to a page.
45 * @param[in] left       - Pointer to a double value receiving the left of the rectangle.
46 * @param[in] bottom     - Pointer to a double value receiving the bottom of the rectangle.
47 * @param[in] right      - Pointer to a double value receiving the right of the rectangle.
48 * @param[in] top        - Pointer to a double value receiving the top of the rectangle.
49 * @retval True if success,else fail.
50 */
51 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetMediaBox(FPDF_PAGE page, float* left, float* bottom, float* right, float* top);
52
53 /**  Get "CropBox" entry from the page dictionary.                                                 
54 * @param[in] page       - Handle to a page.
55 * @param[in] left       - Pointer to a double value receiving the left of the rectangle.
56 * @param[in] bottom     - Pointer to a double value receiving the bottom of the rectangle.
57 * @param[in] right      - Pointer to a double value receiving the right of the rectangle.
58 * @param[in] top        - Pointer to a double value receiving the top of the rectangle.
59 * @retval True if success,else fail.
60 */
61 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetCropBox(FPDF_PAGE page, float* left, float* bottom, float* right, float* top);
62
63 /**
64 * Transform the whole page with a specified matrix, then clip the page content region.
65 *
66 * @param[in] page                - A page handle.
67 * @param[in] matrix              - The transform matrix.
68 * @param[in] clipRect    - A rectangle page area to be clipped.
69 * @Note. This function will transform the whole page, and would take effect to all the objects in the page.
70 */
71 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_TransFormWithClip(FPDF_PAGE page, FS_MATRIX* matrix, FS_RECTF* clipRect);
72
73 /**
74 * Transform (scale, rotate, shear, move) the clip path of page object.
75 * @param[in] page_object - Handle to a page object. Returned by FPDFPageObj_NewImageObj.
76 * @param[in] a  - The coefficient "a" of the matrix.
77 * @param[in] b  - The coefficient "b" of the matrix.
78 * @param[in] c  - The coefficient "c" of the matrix.
79 * @param[in] d  - The coefficient "d" of the matrix.
80 * @param[in] e  - The coefficient "e" of the matrix.
81 * @param[in] f  - The coefficient "f" of the matrix.
82 * @retval None.
83 */
84 DLLEXPORT void STDCALL FPDFPageObj_TransformClipPath(FPDF_PAGEOBJECT page_object,double a, double b, double c, double d, double e, double f);
85
86 /**
87 * Create a new clip path, with a rectangle inserted.
88
89 * @param[in] left       - The left of the clip box.
90 * @param[in] bottom - The bottom of the clip box.
91 * @param[in] right      - The right of the clip box.
92 * @param[in] top        - The top of the clip box.
93 * @retval a handle to the clip path.
94 */
95 DLLEXPORT FPDF_CLIPPATH STDCALL FPDF_CreateClipPath(float left, float bottom, float right, float top);
96
97 /**
98 * Destroy the clip path.
99 *
100 * @param[in] clipPath - A handle to the clip path.
101 * Destroy the clip path.
102 * @retval None.
103 */
104 DLLEXPORT void STDCALL FPDF_DestroyClipPath(FPDF_CLIPPATH clipPath);
105
106 /**
107 * Clip the page content, the page content that outside the clipping region become invisible.
108 *
109 * @param[in] page                - A page handle.
110 * @param[in] clipPath    - A handle to the clip path.
111 * @Note. A clip path will be inserted before the page content stream or content array. In this way, the page content will be clipped
112 * by this clip path. 
113 */
114 DLLEXPORT void STDCALL FPDFPage_InsertClipPath(FPDF_PAGE page,FPDF_CLIPPATH clipPath);
115
116 #ifdef __cplusplus
117 }
118 #endif
119
120 #endif
121