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