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