diff options
Diffstat (limited to 'public/fpdf_transformpage.h')
| -rw-r--r-- | public/fpdf_transformpage.h | 92 |
1 files changed, 45 insertions, 47 deletions
diff --git a/public/fpdf_transformpage.h b/public/fpdf_transformpage.h index dcb56cb7d2..6278b9d0dd 100644 --- a/public/fpdf_transformpage.h +++ b/public/fpdf_transformpage.h @@ -1,15 +1,13 @@ // Copyright 2014 PDFium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. - + // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com -#ifndef _TRANSFORMPAGE_H_ -#define _TRANSFORMPAGE_H_ +#ifndef PUBLIC_FPDF_TRANSFORMPAGE_H_ +#define PUBLIC_FPDF_TRANSFORMPAGE_H_ -#ifndef _FPDFVIEW_H_ #include "fpdfview.h" -#endif #ifdef __cplusplus extern "C" { @@ -17,45 +15,46 @@ extern "C" { typedef void* FPDF_PAGEARCSAVER; typedef void* FPDF_PAGEARCLOADER; + /** -* Set "MediaBox" entry to the page dictionary. -* @param[in] page - Handle to a page. -* @param[in] left - The left of the rectangle. -* @param[in] bottom - The bottom of the rectangle. -* @param[in] right - The right of the rectangle. -* @param[in] top - The top of the rectangle. +* Set "MediaBox" entry to the page dictionary. +* @param[in] page - Handle to a page. +* @param[in] left - The left of the rectangle. +* @param[in] bottom - The bottom of the rectangle. +* @param[in] right - The right of the rectangle. +* @param[in] top - The top of the rectangle. * @retval None. */ DLLEXPORT void STDCALL FPDFPage_SetMediaBox(FPDF_PAGE page, float left, float bottom, float right, float top); /** -* Set "CropBox" entry to the page dictionary. -* @param[in] page - Handle to a page. -* @param[in] left - The left of the rectangle. -* @param[in] bottom - The bottom of the rectangle. -* @param[in] right - The right of the rectangle. -* @param[in] top - The top of the rectangle. +* Set "CropBox" entry to the page dictionary. +* @param[in] page - Handle to a page. +* @param[in] left - The left of the rectangle. +* @param[in] bottom - The bottom of the rectangle. +* @param[in] right - The right of the rectangle. +* @param[in] top - The top of the rectangle. * @retval None. */ 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. +/** 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. * @retval True if success,else fail. */ 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. +/** 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. * @retval True if success,else fail. */ DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetCropBox(FPDF_PAGE page, float* left, float* bottom, float* right, float* top); @@ -63,9 +62,9 @@ DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GetCropBox(FPDF_PAGE page, float* left, flo /** * 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. +* @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. */ DLLEXPORT FPDF_BOOL STDCALL FPDFPage_TransFormWithClip(FPDF_PAGE page, FS_MATRIX* matrix, FS_RECTF* clipRect); @@ -73,23 +72,23 @@ DLLEXPORT FPDF_BOOL STDCALL FPDFPage_TransFormWithClip(FPDF_PAGE page, FS_MATRIX /** * 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] 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. -* @param[in] d - The coefficient "d" of the matrix. -* @param[in] e - The coefficient "e" of the matrix. -* @param[in] f - The coefficient "f" of the matrix. +* @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. +* @param[in] d - The coefficient "d" of the matrix. +* @param[in] e - The coefficient "e" of the 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); /** * Create a new clip path, with a rectangle inserted. -* -* @param[in] left - The left of the clip box. +* +* @param[in] left - The left of the clip box. * @param[in] bottom - The bottom of the clip box. -* @param[in] right - The right of the clip box. -* @param[in] top - The top of the clip box. +* @param[in] right - The right of the clip box. +* @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); @@ -106,10 +105,10 @@ DLLEXPORT void STDCALL FPDF_DestroyClipPath(FPDF_CLIPPATH clipPath); /** * 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. +* @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. +* by this clip path. */ DLLEXPORT void STDCALL FPDFPage_InsertClipPath(FPDF_PAGE page,FPDF_CLIPPATH clipPath); @@ -117,5 +116,4 @@ DLLEXPORT void STDCALL FPDFPage_InsertClipPath(FPDF_PAGE page,FPDF_CLIPPATH clip } #endif -#endif - +#endif // PUBLIC_FPDF_TRANSFORMPAGE_H_ |