summaryrefslogtreecommitdiff
path: root/public/fpdf_transformpage.h
diff options
context:
space:
mode:
Diffstat (limited to 'public/fpdf_transformpage.h')
-rw-r--r--public/fpdf_transformpage.h103
1 files changed, 75 insertions, 28 deletions
diff --git a/public/fpdf_transformpage.h b/public/fpdf_transformpage.h
index 324bcda7f5..21421a18e0 100644
--- a/public/fpdf_transformpage.h
+++ b/public/fpdf_transformpage.h
@@ -24,9 +24,14 @@ typedef void* FPDF_PAGEARCLOADER;
* @param[in] right - The right of the rectangle.
* @param[in] top - The top of the rectangle.
* @retval None.
-* @note The method can not support to set this feature for the document which consists of dynamic XFA fields.
+* @note The method can not support to set this feature for the document which
+* consists of dynamic XFA fields.
*/
-DLLEXPORT void STDCALL FPDFPage_SetMediaBox(FPDF_PAGE page, float left, float bottom, float right, float top);
+DLLEXPORT void STDCALL FPDFPage_SetMediaBox(FPDF_PAGE page,
+ float left,
+ float bottom,
+ float right,
+ float top);
/**
* Set "CropBox" entry to the page dictionary.
@@ -36,47 +41,75 @@ DLLEXPORT void STDCALL FPDFPage_SetMediaBox(FPDF_PAGE page, float left, float bo
* @param[in] right - The right of the rectangle.
* @param[in] top - The top of the rectangle.
* @retval None.
-* @note The method can not support to set this feature for the document which consists of dynamic XFA fields.
+* @note The method can not support to set this feature for the document which
+* consists of dynamic XFA fields.
*/
-DLLEXPORT void STDCALL FPDFPage_SetCropBox(FPDF_PAGE page, float left, float bottom, float right, float top);
-
+DLLEXPORT void STDCALL FPDFPage_SetCropBox(FPDF_PAGE page,
+ float left,
+ float bottom,
+ float right,
+ float top);
/** Get "MediaBox" entry from the page dictionary.
* @param[in] page - Handle to a page.
-* @param[in] left - Pointer to a double value receiving the left of the rectangle.
-* @param[in] bottom - Pointer to a double value receiving the bottom of the rectangle.
-* @param[in] right - Pointer to a double value receiving the right of the rectangle.
-* @param[in] top - Pointer to a double value receiving the top of the rectangle.
+* @param[in] left - Pointer to a double value receiving the left of the
+* rectangle.
+* @param[in] bottom - Pointer to a double value receiving the bottom of the
+* rectangle.
+* @param[in] right - Pointer to a double value receiving the right of the
+* rectangle.
+* @param[in] top - Pointer to a double value receiving the top of the
+* rectangle.
* @retval True if success,else fail.
-* @note The method can not support to get this feature for the document which consists of dynamic XFA fields.
+* @note The method can not support to get this feature for the document which
+* consists of dynamic XFA fields.
*/
-DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetMediaBox(FPDF_PAGE page, float* left, float* bottom, float* right, float* top);
+DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetMediaBox(FPDF_PAGE page,
+ float* left,
+ float* bottom,
+ float* right,
+ float* top);
/** Get "CropBox" entry from the page dictionary.
* @param[in] page - Handle to a page.
-* @param[in] left - Pointer to a double value receiving the left of the rectangle.
-* @param[in] bottom - Pointer to a double value receiving the bottom of the rectangle.
-* @param[in] right - Pointer to a double value receiving the right of the rectangle.
-* @param[in] top - Pointer to a double value receiving the top of the rectangle.
+* @param[in] left - Pointer to a double value receiving the left of the
+* rectangle.
+* @param[in] bottom - Pointer to a double value receiving the bottom of the
+* rectangle.
+* @param[in] right - Pointer to a double value receiving the right of the
+* rectangle.
+* @param[in] top - Pointer to a double value receiving the top of the
+* rectangle.
* @retval True if success,else fail.
-* @note The method can not support to get this feature for the document which consists of dynamic XFA fields.
+* @note The method can not support to get this feature for the document which
+* consists of dynamic XFA fields.
*/
-DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetCropBox(FPDF_PAGE page, float* left, float* bottom, float* right, float* top);
+DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetCropBox(FPDF_PAGE page,
+ float* left,
+ float* bottom,
+ float* right,
+ float* top);
/**
-* Transform the whole page with a specified matrix, then clip the page content region.
+* Transform the whole page with a specified matrix, then clip the page content
+* region.
*
* @param[in] page - A page handle.
* @param[in] matrix - The transform matrix.
* @param[in] clipRect - A rectangle page area to be clipped.
-* @Note. This function will transform the whole page, and would take effect to all the objects in the page.
-* The method can not support to get this feature for the document which consists of dynamic XFA fields.
+* @Note. This function will transform the whole page, and would take effect to
+* all the objects in the page.
+* The method can not support to get this feature for the document which
+* consists of dynamic XFA fields.
*/
-DLLEXPORT FPDF_BOOL STDCALL FPDFPage_TransFormWithClip(FPDF_PAGE page, FS_MATRIX* matrix, FS_RECTF* clipRect);
+DLLEXPORT FPDF_BOOL STDCALL FPDFPage_TransFormWithClip(FPDF_PAGE page,
+ FS_MATRIX* matrix,
+ FS_RECTF* clipRect);
/**
* Transform (scale, rotate, shear, move) the clip path of page object.
-* @param[in] page_object - Handle to a page object. Returned by FPDFPageObj_NewImageObj.
+* @param[in] page_object - Handle to a page object. Returned by
+* FPDFPageObj_NewImageObj.
* @param[in] a - The coefficient "a" of the matrix.
* @param[in] b - The coefficient "b" of the matrix.
* @param[in] c - The coefficient "c" of the matrix.
@@ -85,7 +118,14 @@ DLLEXPORT FPDF_BOOL STDCALL FPDFPage_TransFormWithClip(FPDF_PAGE page, FS_MATRIX
* @param[in] f - The coefficient "f" of the matrix.
* @retval None.
*/
-DLLEXPORT void STDCALL FPDFPageObj_TransformClipPath(FPDF_PAGEOBJECT page_object,double a, double b, double c, double d, double e, double f);
+DLLEXPORT void STDCALL
+FPDFPageObj_TransformClipPath(FPDF_PAGEOBJECT page_object,
+ double a,
+ double b,
+ double c,
+ double d,
+ double e,
+ double f);
/**
* Create a new clip path, with a rectangle inserted.
@@ -96,7 +136,10 @@ DLLEXPORT void STDCALL FPDFPageObj_TransformClipPath(FPDF_PAGEOBJECT page_object
* @param[in] top - The top of the clip box.
* @retval a handle to the clip path.
*/
-DLLEXPORT FPDF_CLIPPATH STDCALL FPDF_CreateClipPath(float left, float bottom, float right, float top);
+DLLEXPORT FPDF_CLIPPATH STDCALL FPDF_CreateClipPath(float left,
+ float bottom,
+ float right,
+ float top);
/**
* Destroy the clip path.
@@ -108,14 +151,18 @@ DLLEXPORT FPDF_CLIPPATH STDCALL FPDF_CreateClipPath(float left, float bottom, fl
DLLEXPORT void STDCALL FPDF_DestroyClipPath(FPDF_CLIPPATH clipPath);
/**
-* Clip the page content, the page content that outside the clipping region become invisible.
+* Clip the page content, the page content that outside the clipping region
+* become invisible.
*
* @param[in] page - A page handle.
* @param[in] clipPath - A handle to the clip path.
-* @Note. A clip path will be inserted before the page content stream or content array. In this way, the page content will be clipped
-* by this clip path. The method can not support this feature for the document consists of dynamic XFA fields.
+* @Note. A clip path will be inserted before the page content stream or content
+* array. In this way, the page content will be clipped
+* by this clip path. The method can not support this feature for the document
+* consists of dynamic XFA fields.
*/
-DLLEXPORT void STDCALL FPDFPage_InsertClipPath(FPDF_PAGE page,FPDF_CLIPPATH clipPath);
+DLLEXPORT void STDCALL FPDFPage_InsertClipPath(FPDF_PAGE page,
+ FPDF_CLIPPATH clipPath);
#ifdef __cplusplus
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 23:40:58 +0000