You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1230 lines
45 KiB
1230 lines
45 KiB
// 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 PUBLIC_FPDF_EDIT_H_
|
|
#define PUBLIC_FPDF_EDIT_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
// NOLINTNEXTLINE(build/include)
|
|
#include "fpdfview.h"
|
|
|
|
#define FPDF_ARGB(a, r, g, b) \
|
|
((uint32_t)(((uint32_t)(b)&0xff) | (((uint32_t)(g)&0xff) << 8) | \
|
|
(((uint32_t)(r)&0xff) << 16) | (((uint32_t)(a)&0xff) << 24)))
|
|
#define FPDF_GetBValue(argb) ((uint8_t)(argb))
|
|
#define FPDF_GetGValue(argb) ((uint8_t)(((uint16_t)(argb)) >> 8))
|
|
#define FPDF_GetRValue(argb) ((uint8_t)((argb) >> 16))
|
|
#define FPDF_GetAValue(argb) ((uint8_t)((argb) >> 24))
|
|
|
|
// Refer to PDF Reference version 1.7 table 4.12 for all color space families.
|
|
#define FPDF_COLORSPACE_UNKNOWN 0
|
|
#define FPDF_COLORSPACE_DEVICEGRAY 1
|
|
#define FPDF_COLORSPACE_DEVICERGB 2
|
|
#define FPDF_COLORSPACE_DEVICECMYK 3
|
|
#define FPDF_COLORSPACE_CALGRAY 4
|
|
#define FPDF_COLORSPACE_CALRGB 5
|
|
#define FPDF_COLORSPACE_LAB 6
|
|
#define FPDF_COLORSPACE_ICCBASED 7
|
|
#define FPDF_COLORSPACE_SEPARATION 8
|
|
#define FPDF_COLORSPACE_DEVICEN 9
|
|
#define FPDF_COLORSPACE_INDEXED 10
|
|
#define FPDF_COLORSPACE_PATTERN 11
|
|
|
|
// The page object constants.
|
|
#define FPDF_PAGEOBJ_UNKNOWN 0
|
|
#define FPDF_PAGEOBJ_TEXT 1
|
|
#define FPDF_PAGEOBJ_PATH 2
|
|
#define FPDF_PAGEOBJ_IMAGE 3
|
|
#define FPDF_PAGEOBJ_SHADING 4
|
|
#define FPDF_PAGEOBJ_FORM 5
|
|
|
|
// The path segment constants.
|
|
#define FPDF_SEGMENT_UNKNOWN -1
|
|
#define FPDF_SEGMENT_LINETO 0
|
|
#define FPDF_SEGMENT_BEZIERTO 1
|
|
#define FPDF_SEGMENT_MOVETO 2
|
|
|
|
#define FPDF_FILLMODE_NONE 0
|
|
#define FPDF_FILLMODE_ALTERNATE 1
|
|
#define FPDF_FILLMODE_WINDING 2
|
|
|
|
#define FPDF_FONT_TYPE1 1
|
|
#define FPDF_FONT_TRUETYPE 2
|
|
|
|
#define FPDF_LINECAP_BUTT 0
|
|
#define FPDF_LINECAP_ROUND 1
|
|
#define FPDF_LINECAP_PROJECTING_SQUARE 2
|
|
|
|
#define FPDF_LINEJOIN_MITER 0
|
|
#define FPDF_LINEJOIN_ROUND 1
|
|
#define FPDF_LINEJOIN_BEVEL 2
|
|
|
|
#define FPDF_PRINTMODE_EMF 0
|
|
#define FPDF_PRINTMODE_TEXTONLY 1
|
|
#define FPDF_PRINTMODE_POSTSCRIPT2 2
|
|
#define FPDF_PRINTMODE_POSTSCRIPT3 3
|
|
#define FPDF_PRINTMODE_POSTSCRIPT2_PASSTHROUGH 4
|
|
#define FPDF_PRINTMODE_POSTSCRIPT3_PASSTHROUGH 5
|
|
|
|
typedef struct FPDF_IMAGEOBJ_METADATA {
|
|
// The image width in pixels.
|
|
unsigned int width;
|
|
// The image height in pixels.
|
|
unsigned int height;
|
|
// The image's horizontal pixel-per-inch.
|
|
float horizontal_dpi;
|
|
// The image's vertical pixel-per-inch.
|
|
float vertical_dpi;
|
|
// The number of bits used to represent each pixel.
|
|
unsigned int bits_per_pixel;
|
|
// The image's colorspace. See above for the list of FPDF_COLORSPACE_*.
|
|
int colorspace;
|
|
// The image's marked content ID. Useful for pairing with associated alt-text.
|
|
// A value of -1 indicates no ID.
|
|
int marked_content_id;
|
|
} FPDF_IMAGEOBJ_METADATA;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif // __cplusplus
|
|
|
|
// Create a new PDF document.
|
|
//
|
|
// Returns a handle to a new document, or NULL on failure.
|
|
FPDF_EXPORT FPDF_DOCUMENT FPDF_CALLCONV FPDF_CreateNewDocument();
|
|
|
|
// Create a new PDF page.
|
|
//
|
|
// document - handle to document.
|
|
// page_index - suggested 0-based index of the page to create. If it is larger
|
|
// than document's current last index(L), the created page index
|
|
// is the next available index -- L+1.
|
|
// width - the page width in points.
|
|
// height - the page height in points.
|
|
//
|
|
// Returns the handle to the new page or NULL on failure.
|
|
//
|
|
// The page should be closed with FPDF_ClosePage() when finished as
|
|
// with any other page in the document.
|
|
FPDF_EXPORT FPDF_PAGE FPDF_CALLCONV FPDFPage_New(FPDF_DOCUMENT document,
|
|
int page_index,
|
|
double width,
|
|
double height);
|
|
|
|
// Delete the page at |page_index|.
|
|
//
|
|
// document - handle to document.
|
|
// page_index - the index of the page to delete.
|
|
FPDF_EXPORT void FPDF_CALLCONV FPDFPage_Delete(FPDF_DOCUMENT document,
|
|
int page_index);
|
|
|
|
// Get the rotation of |page|.
|
|
//
|
|
// page - handle to a page
|
|
//
|
|
// Returns one of the following indicating the page rotation:
|
|
// 0 - No rotation.
|
|
// 1 - Rotated 90 degrees clockwise.
|
|
// 2 - Rotated 180 degrees clockwise.
|
|
// 3 - Rotated 270 degrees clockwise.
|
|
FPDF_EXPORT int FPDF_CALLCONV FPDFPage_GetRotation(FPDF_PAGE page);
|
|
|
|
// Set rotation for |page|.
|
|
//
|
|
// page - handle to a page.
|
|
// rotate - the rotation value, one of:
|
|
// 0 - No rotation.
|
|
// 1 - Rotated 90 degrees clockwise.
|
|
// 2 - Rotated 180 degrees clockwise.
|
|
// 3 - Rotated 270 degrees clockwise.
|
|
FPDF_EXPORT void FPDF_CALLCONV FPDFPage_SetRotation(FPDF_PAGE page, int rotate);
|
|
|
|
// Insert |page_obj| into |page|.
|
|
//
|
|
// page - handle to a page
|
|
// page_obj - handle to a page object. The |page_obj| will be automatically
|
|
// freed.
|
|
FPDF_EXPORT void FPDF_CALLCONV FPDFPage_InsertObject(FPDF_PAGE page,
|
|
FPDF_PAGEOBJECT page_obj);
|
|
|
|
// Experimental API.
|
|
// Remove |page_obj| from |page|.
|
|
//
|
|
// page - handle to a page
|
|
// page_obj - handle to a page object to be removed.
|
|
//
|
|
// Returns TRUE on success.
|
|
//
|
|
// Ownership is transferred to the caller. Call FPDFPageObj_Destroy() to free
|
|
// it.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPage_RemoveObject(FPDF_PAGE page, FPDF_PAGEOBJECT page_obj);
|
|
|
|
// Get number of page objects inside |page|.
|
|
//
|
|
// page - handle to a page.
|
|
//
|
|
// Returns the number of objects in |page|.
|
|
FPDF_EXPORT int FPDF_CALLCONV FPDFPage_CountObjects(FPDF_PAGE page);
|
|
|
|
// Get object in |page| at |index|.
|
|
//
|
|
// page - handle to a page.
|
|
// index - the index of a page object.
|
|
//
|
|
// Returns the handle to the page object, or NULL on failed.
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV FPDFPage_GetObject(FPDF_PAGE page,
|
|
int index);
|
|
|
|
// Checks if |page| contains transparency.
|
|
//
|
|
// page - handle to a page.
|
|
//
|
|
// Returns TRUE if |page| contains transparency.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPage_HasTransparency(FPDF_PAGE page);
|
|
|
|
// Generate the content of |page|.
|
|
//
|
|
// page - handle to a page.
|
|
//
|
|
// Returns TRUE on success.
|
|
//
|
|
// Before you save the page to a file, or reload the page, you must call
|
|
// |FPDFPage_GenerateContent| or any changes to |page| will be lost.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPage_GenerateContent(FPDF_PAGE page);
|
|
|
|
// Destroy |page_obj| by releasing its resources. |page_obj| must have been
|
|
// created by FPDFPageObj_CreateNew{Path|Rect}() or
|
|
// FPDFPageObj_New{Text|Image}Obj(). This function must be called on
|
|
// newly-created objects if they are not added to a page through
|
|
// FPDFPage_InsertObject() or to an annotation through FPDFAnnot_AppendObject().
|
|
//
|
|
// page_obj - handle to a page object.
|
|
FPDF_EXPORT void FPDF_CALLCONV FPDFPageObj_Destroy(FPDF_PAGEOBJECT page_obj);
|
|
|
|
// Checks if |page_object| contains transparency.
|
|
//
|
|
// page_object - handle to a page object.
|
|
//
|
|
// Returns TRUE if |page_object| contains transparency.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_HasTransparency(FPDF_PAGEOBJECT page_object);
|
|
|
|
// Get type of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
//
|
|
// Returns one of the FPDF_PAGEOBJ_* values on success, FPDF_PAGEOBJ_UNKNOWN on
|
|
// error.
|
|
FPDF_EXPORT int FPDF_CALLCONV FPDFPageObj_GetType(FPDF_PAGEOBJECT page_object);
|
|
|
|
// Transform |page_object| by the given matrix.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// a - matrix value.
|
|
// b - matrix value.
|
|
// c - matrix value.
|
|
// d - matrix value.
|
|
// e - matrix value.
|
|
// f - matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and can be used to scale, rotate, shear and translate the |page_object|.
|
|
FPDF_EXPORT void FPDF_CALLCONV
|
|
FPDFPageObj_Transform(FPDF_PAGEOBJECT page_object,
|
|
double a,
|
|
double b,
|
|
double c,
|
|
double d,
|
|
double e,
|
|
double f);
|
|
|
|
// Transform all annotations in |page|.
|
|
//
|
|
// page - handle to a page.
|
|
// a - matrix value.
|
|
// b - matrix value.
|
|
// c - matrix value.
|
|
// d - matrix value.
|
|
// e - matrix value.
|
|
// f - matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and can be used to scale, rotate, shear and translate the |page| annotations.
|
|
FPDF_EXPORT void FPDF_CALLCONV FPDFPage_TransformAnnots(FPDF_PAGE page,
|
|
double a,
|
|
double b,
|
|
double c,
|
|
double d,
|
|
double e,
|
|
double f);
|
|
|
|
// Create a new image object.
|
|
//
|
|
// document - handle to a document.
|
|
//
|
|
// Returns a handle to a new image object.
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV
|
|
FPDFPageObj_NewImageObj(FPDF_DOCUMENT document);
|
|
|
|
// Experimental API.
|
|
// Get number of content marks in |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
//
|
|
// Returns the number of content marks in |page_object|, or -1 in case of
|
|
// failure.
|
|
FPDF_EXPORT int FPDF_CALLCONV
|
|
FPDFPageObj_CountMarks(FPDF_PAGEOBJECT page_object);
|
|
|
|
// Experimental API.
|
|
// Get content mark in |page_object| at |index|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// index - the index of a page object.
|
|
//
|
|
// Returns the handle to the content mark, or NULL on failure. The handle is
|
|
// still owned by the library, and it should not be freed directly. It becomes
|
|
// invalid if the page object is destroyed, either directly or indirectly by
|
|
// unloading the page.
|
|
FPDF_EXPORT FPDF_PAGEOBJECTMARK FPDF_CALLCONV
|
|
FPDFPageObj_GetMark(FPDF_PAGEOBJECT page_object, unsigned long index);
|
|
|
|
// Experimental API.
|
|
// Add a new content mark to a |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// name - the name (tag) of the mark.
|
|
//
|
|
// Returns the handle to the content mark, or NULL on failure. The handle is
|
|
// still owned by the library, and it should not be freed directly. It becomes
|
|
// invalid if the page object is destroyed, either directly or indirectly by
|
|
// unloading the page.
|
|
FPDF_EXPORT FPDF_PAGEOBJECTMARK FPDF_CALLCONV
|
|
FPDFPageObj_AddMark(FPDF_PAGEOBJECT page_object, FPDF_BYTESTRING name);
|
|
|
|
// Experimental API.
|
|
// Removes a content |mark| from a |page_object|.
|
|
// The mark handle will be invalid after the removal.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// mark - handle to a content mark in that object to remove.
|
|
//
|
|
// Returns TRUE if the operation succeeded, FALSE if it failed.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_RemoveMark(FPDF_PAGEOBJECT page_object, FPDF_PAGEOBJECTMARK mark);
|
|
|
|
// Experimental API.
|
|
// Get the name of a content mark.
|
|
//
|
|
// mark - handle to a content mark.
|
|
// buffer - buffer for holding the returned name in UTF-16LE. This is only
|
|
// modified if |buflen| is longer than the length of the name.
|
|
// Optional, pass null to just retrieve the size of the buffer
|
|
// needed.
|
|
// buflen - length of the buffer.
|
|
// out_buflen - pointer to variable that will receive the minimum buffer size
|
|
// to contain the name. Not filled if FALSE is returned.
|
|
//
|
|
// Returns TRUE if the operation succeeded, FALSE if it failed.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_GetName(FPDF_PAGEOBJECTMARK mark,
|
|
void* buffer,
|
|
unsigned long buflen,
|
|
unsigned long* out_buflen);
|
|
|
|
// Experimental API.
|
|
// Get the number of key/value pair parameters in |mark|.
|
|
//
|
|
// mark - handle to a content mark.
|
|
//
|
|
// Returns the number of key/value pair parameters |mark|, or -1 in case of
|
|
// failure.
|
|
FPDF_EXPORT int FPDF_CALLCONV
|
|
FPDFPageObjMark_CountParams(FPDF_PAGEOBJECTMARK mark);
|
|
|
|
// Experimental API.
|
|
// Get the key of a property in a content mark.
|
|
//
|
|
// mark - handle to a content mark.
|
|
// index - index of the property.
|
|
// buffer - buffer for holding the returned key in UTF-16LE. This is only
|
|
// modified if |buflen| is longer than the length of the key.
|
|
// Optional, pass null to just retrieve the size of the buffer
|
|
// needed.
|
|
// buflen - length of the buffer.
|
|
// out_buflen - pointer to variable that will receive the minimum buffer size
|
|
// to contain the key. Not filled if FALSE is returned.
|
|
//
|
|
// Returns TRUE if the operation was successful, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_GetParamKey(FPDF_PAGEOBJECTMARK mark,
|
|
unsigned long index,
|
|
void* buffer,
|
|
unsigned long buflen,
|
|
unsigned long* out_buflen);
|
|
|
|
// Experimental API.
|
|
// Get the type of the value of a property in a content mark by key.
|
|
//
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
//
|
|
// Returns the type of the value, or FPDF_OBJECT_UNKNOWN in case of failure.
|
|
FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV
|
|
FPDFPageObjMark_GetParamValueType(FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key);
|
|
|
|
// Experimental API.
|
|
// Get the value of a number property in a content mark by key as int.
|
|
// FPDFPageObjMark_GetParamValueType() should have returned FPDF_OBJECT_NUMBER
|
|
// for this property.
|
|
//
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
// out_value - pointer to variable that will receive the value. Not filled if
|
|
// false is returned.
|
|
//
|
|
// Returns TRUE if the key maps to a number value, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_GetParamIntValue(FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key,
|
|
int* out_value);
|
|
|
|
// Experimental API.
|
|
// Get the value of a string property in a content mark by key.
|
|
//
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
// buffer - buffer for holding the returned value in UTF-16LE. This is
|
|
// only modified if |buflen| is longer than the length of the
|
|
// value.
|
|
// Optional, pass null to just retrieve the size of the buffer
|
|
// needed.
|
|
// buflen - length of the buffer.
|
|
// out_buflen - pointer to variable that will receive the minimum buffer size
|
|
// to contain the value. Not filled if FALSE is returned.
|
|
//
|
|
// Returns TRUE if the key maps to a string/blob value, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_GetParamStringValue(FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key,
|
|
void* buffer,
|
|
unsigned long buflen,
|
|
unsigned long* out_buflen);
|
|
|
|
// Experimental API.
|
|
// Get the value of a blob property in a content mark by key.
|
|
//
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
// buffer - buffer for holding the returned value. This is only modified
|
|
// if |buflen| is at least as long as the length of the value.
|
|
// Optional, pass null to just retrieve the size of the buffer
|
|
// needed.
|
|
// buflen - length of the buffer.
|
|
// out_buflen - pointer to variable that will receive the minimum buffer size
|
|
// to contain the value. Not filled if FALSE is returned.
|
|
//
|
|
// Returns TRUE if the key maps to a string/blob value, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_GetParamBlobValue(FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key,
|
|
void* buffer,
|
|
unsigned long buflen,
|
|
unsigned long* out_buflen);
|
|
|
|
// Experimental API.
|
|
// Set the value of an int property in a content mark by key. If a parameter
|
|
// with key |key| exists, its value is set to |value|. Otherwise, it is added as
|
|
// a new parameter.
|
|
//
|
|
// document - handle to the document.
|
|
// page_object - handle to the page object with the mark.
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
// value - int value to set.
|
|
//
|
|
// Returns TRUE if the operation succeeded, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_SetIntParam(FPDF_DOCUMENT document,
|
|
FPDF_PAGEOBJECT page_object,
|
|
FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key,
|
|
int value);
|
|
|
|
// Experimental API.
|
|
// Set the value of a string property in a content mark by key. If a parameter
|
|
// with key |key| exists, its value is set to |value|. Otherwise, it is added as
|
|
// a new parameter.
|
|
//
|
|
// document - handle to the document.
|
|
// page_object - handle to the page object with the mark.
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
// value - string value to set.
|
|
//
|
|
// Returns TRUE if the operation succeeded, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_SetStringParam(FPDF_DOCUMENT document,
|
|
FPDF_PAGEOBJECT page_object,
|
|
FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key,
|
|
FPDF_BYTESTRING value);
|
|
|
|
// Experimental API.
|
|
// Set the value of a blob property in a content mark by key. If a parameter
|
|
// with key |key| exists, its value is set to |value|. Otherwise, it is added as
|
|
// a new parameter.
|
|
//
|
|
// document - handle to the document.
|
|
// page_object - handle to the page object with the mark.
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
// value - pointer to blob value to set.
|
|
// value_len - size in bytes of |value|.
|
|
//
|
|
// Returns TRUE if the operation succeeded, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_SetBlobParam(FPDF_DOCUMENT document,
|
|
FPDF_PAGEOBJECT page_object,
|
|
FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key,
|
|
void* value,
|
|
unsigned long value_len);
|
|
|
|
// Experimental API.
|
|
// Removes a property from a content mark by key.
|
|
//
|
|
// page_object - handle to the page object with the mark.
|
|
// mark - handle to a content mark.
|
|
// key - string key of the property.
|
|
//
|
|
// Returns TRUE if the operation succeeded, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObjMark_RemoveParam(FPDF_PAGEOBJECT page_object,
|
|
FPDF_PAGEOBJECTMARK mark,
|
|
FPDF_BYTESTRING key);
|
|
|
|
// Load an image from a JPEG image file and then set it into |image_object|.
|
|
//
|
|
// pages - pointer to the start of all loaded pages, may be NULL.
|
|
// count - number of |pages|, may be 0.
|
|
// image_object - handle to an image object.
|
|
// file_access - file access handler which specifies the JPEG image file.
|
|
//
|
|
// Returns TRUE on success.
|
|
//
|
|
// The image object might already have an associated image, which is shared and
|
|
// cached by the loaded pages. In that case, we need to clear the cached image
|
|
// for all the loaded pages. Pass |pages| and page count (|count|) to this API
|
|
// to clear the image cache. If the image is not previously shared, or NULL is a
|
|
// valid |pages| value.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFImageObj_LoadJpegFile(FPDF_PAGE* pages,
|
|
int count,
|
|
FPDF_PAGEOBJECT image_object,
|
|
FPDF_FILEACCESS* file_access);
|
|
|
|
// Load an image from a JPEG image file and then set it into |image_object|.
|
|
//
|
|
// pages - pointer to the start of all loaded pages, may be NULL.
|
|
// count - number of |pages|, may be 0.
|
|
// image_object - handle to an image object.
|
|
// file_access - file access handler which specifies the JPEG image file.
|
|
//
|
|
// Returns TRUE on success.
|
|
//
|
|
// The image object might already have an associated image, which is shared and
|
|
// cached by the loaded pages. In that case, we need to clear the cached image
|
|
// for all the loaded pages. Pass |pages| and page count (|count|) to this API
|
|
// to clear the image cache. If the image is not previously shared, or NULL is a
|
|
// valid |pages| value. This function loads the JPEG image inline, so the image
|
|
// content is copied to the file. This allows |file_access| and its associated
|
|
// data to be deleted after this function returns.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFImageObj_LoadJpegFileInline(FPDF_PAGE* pages,
|
|
int count,
|
|
FPDF_PAGEOBJECT image_object,
|
|
FPDF_FILEACCESS* file_access);
|
|
|
|
// Experimental API.
|
|
// Get the transform matrix of an image object.
|
|
//
|
|
// image_object - handle to an image object.
|
|
// a - matrix value.
|
|
// b - matrix value.
|
|
// c - matrix value.
|
|
// d - matrix value.
|
|
// e - matrix value.
|
|
// f - matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and used to scale, rotate, shear and translate the image.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFImageObj_GetMatrix(FPDF_PAGEOBJECT image_object,
|
|
double* a,
|
|
double* b,
|
|
double* c,
|
|
double* d,
|
|
double* e,
|
|
double* f);
|
|
|
|
// Set the transform matrix of |image_object|.
|
|
//
|
|
// image_object - handle to an image object.
|
|
// a - matrix value.
|
|
// b - matrix value.
|
|
// c - matrix value.
|
|
// d - matrix value.
|
|
// e - matrix value.
|
|
// f - matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and can be used to scale, rotate, shear and translate the |image_object|.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFImageObj_SetMatrix(FPDF_PAGEOBJECT image_object,
|
|
double a,
|
|
double b,
|
|
double c,
|
|
double d,
|
|
double e,
|
|
double f);
|
|
|
|
// Set |bitmap| to |image_object|.
|
|
//
|
|
// pages - pointer to the start of all loaded pages, may be NULL.
|
|
// count - number of |pages|, may be 0.
|
|
// image_object - handle to an image object.
|
|
// bitmap - handle of the bitmap.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFImageObj_SetBitmap(FPDF_PAGE* pages,
|
|
int count,
|
|
FPDF_PAGEOBJECT image_object,
|
|
FPDF_BITMAP bitmap);
|
|
|
|
// Get a bitmap rasterisation of |image_object|. The returned bitmap will be
|
|
// owned by the caller, and FPDFBitmap_Destroy() must be called on the returned
|
|
// bitmap when it is no longer needed.
|
|
//
|
|
// image_object - handle to an image object.
|
|
//
|
|
// Returns the bitmap.
|
|
FPDF_EXPORT FPDF_BITMAP FPDF_CALLCONV
|
|
FPDFImageObj_GetBitmap(FPDF_PAGEOBJECT image_object);
|
|
|
|
// Get the decoded image data of |image_object|. The decoded data is the
|
|
// uncompressed image data, i.e. the raw image data after having all filters
|
|
// applied. |buffer| is only modified if |buflen| is longer than the length of
|
|
// the decoded image data.
|
|
//
|
|
// image_object - handle to an image object.
|
|
// buffer - buffer for holding the decoded image data.
|
|
// buflen - length of the buffer in bytes.
|
|
//
|
|
// Returns the length of the decoded image data.
|
|
FPDF_EXPORT unsigned long FPDF_CALLCONV
|
|
FPDFImageObj_GetImageDataDecoded(FPDF_PAGEOBJECT image_object,
|
|
void* buffer,
|
|
unsigned long buflen);
|
|
|
|
// Get the raw image data of |image_object|. The raw data is the image data as
|
|
// stored in the PDF without applying any filters. |buffer| is only modified if
|
|
// |buflen| is longer than the length of the raw image data.
|
|
//
|
|
// image_object - handle to an image object.
|
|
// buffer - buffer for holding the raw image data.
|
|
// buflen - length of the buffer in bytes.
|
|
//
|
|
// Returns the length of the raw image data.
|
|
FPDF_EXPORT unsigned long FPDF_CALLCONV
|
|
FPDFImageObj_GetImageDataRaw(FPDF_PAGEOBJECT image_object,
|
|
void* buffer,
|
|
unsigned long buflen);
|
|
|
|
// Get the number of filters (i.e. decoders) of the image in |image_object|.
|
|
//
|
|
// image_object - handle to an image object.
|
|
//
|
|
// Returns the number of |image_object|'s filters.
|
|
FPDF_EXPORT int FPDF_CALLCONV
|
|
FPDFImageObj_GetImageFilterCount(FPDF_PAGEOBJECT image_object);
|
|
|
|
// Get the filter at |index| of |image_object|'s list of filters. Note that the
|
|
// filters need to be applied in order, i.e. the first filter should be applied
|
|
// first, then the second, etc. |buffer| is only modified if |buflen| is longer
|
|
// than the length of the filter string.
|
|
//
|
|
// image_object - handle to an image object.
|
|
// index - the index of the filter requested.
|
|
// buffer - buffer for holding filter string, encoded in UTF-8.
|
|
// buflen - length of the buffer.
|
|
//
|
|
// Returns the length of the filter string.
|
|
FPDF_EXPORT unsigned long FPDF_CALLCONV
|
|
FPDFImageObj_GetImageFilter(FPDF_PAGEOBJECT image_object,
|
|
int index,
|
|
void* buffer,
|
|
unsigned long buflen);
|
|
|
|
// Get the image metadata of |image_object|, including dimension, DPI, bits per
|
|
// pixel, and colorspace. If the |image_object| is not an image object or if it
|
|
// does not have an image, then the return value will be false. Otherwise,
|
|
// failure to retrieve any specific parameter would result in its value being 0.
|
|
//
|
|
// image_object - handle to an image object.
|
|
// page - handle to the page that |image_object| is on. Required for
|
|
// retrieving the image's bits per pixel and colorspace.
|
|
// metadata - receives the image metadata; must not be NULL.
|
|
//
|
|
// Returns true if successful.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFImageObj_GetImageMetadata(FPDF_PAGEOBJECT image_object,
|
|
FPDF_PAGE page,
|
|
FPDF_IMAGEOBJ_METADATA* metadata);
|
|
|
|
// Create a new path object at an initial position.
|
|
//
|
|
// x - initial horizontal position.
|
|
// y - initial vertical position.
|
|
//
|
|
// Returns a handle to a new path object.
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV FPDFPageObj_CreateNewPath(float x,
|
|
float y);
|
|
|
|
// Create a closed path consisting of a rectangle.
|
|
//
|
|
// x - horizontal position for the left boundary of the rectangle.
|
|
// y - vertical position for the bottom boundary of the rectangle.
|
|
// w - width of the rectangle.
|
|
// h - height of the rectangle.
|
|
//
|
|
// Returns a handle to the new path object.
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV FPDFPageObj_CreateNewRect(float x,
|
|
float y,
|
|
float w,
|
|
float h);
|
|
|
|
// Get the bounding box of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// left - pointer where the left coordinate will be stored
|
|
// bottom - pointer where the bottom coordinate will be stored
|
|
// right - pointer where the right coordinate will be stored
|
|
// top - pointer where the top coordinate will be stored
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_GetBounds(FPDF_PAGEOBJECT page_object,
|
|
float* left,
|
|
float* bottom,
|
|
float* right,
|
|
float* top);
|
|
|
|
// Set the blend mode of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// blend_mode - string containing the blend mode.
|
|
//
|
|
// Blend mode can be one of following: Color, ColorBurn, ColorDodge, Darken,
|
|
// Difference, Exclusion, HardLight, Hue, Lighten, Luminosity, Multiply, Normal,
|
|
// Overlay, Saturation, Screen, SoftLight
|
|
FPDF_EXPORT void FPDF_CALLCONV
|
|
FPDFPageObj_SetBlendMode(FPDF_PAGEOBJECT page_object,
|
|
FPDF_BYTESTRING blend_mode);
|
|
|
|
// Set the stroke RGBA of a page object. Range of values: 0 - 255.
|
|
//
|
|
// page_object - the handle to the page object.
|
|
// R - the red component for the object's stroke color.
|
|
// G - the green component for the object's stroke color.
|
|
// B - the blue component for the object's stroke color.
|
|
// A - the stroke alpha for the object.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_SetStrokeColor(FPDF_PAGEOBJECT page_object,
|
|
unsigned int R,
|
|
unsigned int G,
|
|
unsigned int B,
|
|
unsigned int A);
|
|
|
|
// Get the stroke RGBA of a page object. Range of values: 0 - 255.
|
|
//
|
|
// page_object - the handle to the page object.
|
|
// R - the red component of the path stroke color.
|
|
// G - the green component of the object's stroke color.
|
|
// B - the blue component of the object's stroke color.
|
|
// A - the stroke alpha of the object.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_GetStrokeColor(FPDF_PAGEOBJECT page_object,
|
|
unsigned int* R,
|
|
unsigned int* G,
|
|
unsigned int* B,
|
|
unsigned int* A);
|
|
|
|
// Set the stroke width of a page object.
|
|
//
|
|
// path - the handle to the page object.
|
|
// width - the width of the stroke.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_SetStrokeWidth(FPDF_PAGEOBJECT page_object, float width);
|
|
|
|
// Experimental API.
|
|
// Get the stroke width of a page object.
|
|
//
|
|
// path - the handle to the page object.
|
|
// width - the width of the stroke.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_GetStrokeWidth(FPDF_PAGEOBJECT page_object, float* width);
|
|
|
|
// Get the line join of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
//
|
|
// Returns the line join, or -1 on failure.
|
|
// Line join can be one of following: FPDF_LINEJOIN_MITER, FPDF_LINEJOIN_ROUND,
|
|
// FPDF_LINEJOIN_BEVEL
|
|
FPDF_EXPORT int FPDF_CALLCONV
|
|
FPDFPageObj_GetLineJoin(FPDF_PAGEOBJECT page_object);
|
|
|
|
// Set the line join of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// line_join - line join
|
|
//
|
|
// Line join can be one of following: FPDF_LINEJOIN_MITER, FPDF_LINEJOIN_ROUND,
|
|
// FPDF_LINEJOIN_BEVEL
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_SetLineJoin(FPDF_PAGEOBJECT page_object, int line_join);
|
|
|
|
// Get the line cap of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
//
|
|
// Returns the line cap, or -1 on failure.
|
|
// Line cap can be one of following: FPDF_LINECAP_BUTT, FPDF_LINECAP_ROUND,
|
|
// FPDF_LINECAP_PROJECTING_SQUARE
|
|
FPDF_EXPORT int FPDF_CALLCONV
|
|
FPDFPageObj_GetLineCap(FPDF_PAGEOBJECT page_object);
|
|
|
|
// Set the line cap of |page_object|.
|
|
//
|
|
// page_object - handle to a page object.
|
|
// line_cap - line cap
|
|
//
|
|
// Line cap can be one of following: FPDF_LINECAP_BUTT, FPDF_LINECAP_ROUND,
|
|
// FPDF_LINECAP_PROJECTING_SQUARE
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_SetLineCap(FPDF_PAGEOBJECT page_object, int line_cap);
|
|
|
|
// Set the fill RGBA of a page object. Range of values: 0 - 255.
|
|
//
|
|
// page_object - the handle to the page object.
|
|
// R - the red component for the object's fill color.
|
|
// G - the green component for the object's fill color.
|
|
// B - the blue component for the object's fill color.
|
|
// A - the fill alpha for the object.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_SetFillColor(FPDF_PAGEOBJECT page_object,
|
|
unsigned int R,
|
|
unsigned int G,
|
|
unsigned int B,
|
|
unsigned int A);
|
|
|
|
// Get the fill RGBA of a page object. Range of values: 0 - 255.
|
|
//
|
|
// page_object - the handle to the page object.
|
|
// R - the red component of the object's fill color.
|
|
// G - the green component of the object's fill color.
|
|
// B - the blue component of the object's fill color.
|
|
// A - the fill alpha of the object.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPageObj_GetFillColor(FPDF_PAGEOBJECT page_object,
|
|
unsigned int* R,
|
|
unsigned int* G,
|
|
unsigned int* B,
|
|
unsigned int* A);
|
|
|
|
// Experimental API.
|
|
// Get number of segments inside |path|.
|
|
//
|
|
// path - handle to a path.
|
|
//
|
|
// A segment is a command, created by e.g. FPDFPath_MoveTo(),
|
|
// FPDFPath_LineTo() or FPDFPath_BezierTo().
|
|
//
|
|
// Returns the number of objects in |path| or -1 on failure.
|
|
FPDF_EXPORT int FPDF_CALLCONV FPDFPath_CountSegments(FPDF_PAGEOBJECT path);
|
|
|
|
// Experimental API.
|
|
// Get segment in |path| at |index|.
|
|
//
|
|
// path - handle to a path.
|
|
// index - the index of a segment.
|
|
//
|
|
// Returns the handle to the segment, or NULL on faiure.
|
|
FPDF_EXPORT FPDF_PATHSEGMENT FPDF_CALLCONV
|
|
FPDFPath_GetPathSegment(FPDF_PAGEOBJECT path, int index);
|
|
|
|
// Experimental API.
|
|
// Get coordinates of |segment|.
|
|
//
|
|
// segment - handle to a segment.
|
|
// x - the horizontal position of the segment.
|
|
// y - the vertical position of the segment.
|
|
//
|
|
// Returns TRUE on success, otherwise |x| and |y| is not set.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPathSegment_GetPoint(FPDF_PATHSEGMENT segment, float* x, float* y);
|
|
|
|
// Experimental API.
|
|
// Get type of |segment|.
|
|
//
|
|
// segment - handle to a segment.
|
|
//
|
|
// Returns one of the FPDF_SEGMENT_* values on success,
|
|
// FPDF_SEGMENT_UNKNOWN on error.
|
|
FPDF_EXPORT int FPDF_CALLCONV FPDFPathSegment_GetType(FPDF_PATHSEGMENT segment);
|
|
|
|
// Experimental API.
|
|
// Gets if the |segment| closes the current subpath of a given path.
|
|
//
|
|
// segment - handle to a segment.
|
|
//
|
|
// Returns close flag for non-NULL segment, FALSE otherwise.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFPathSegment_GetClose(FPDF_PATHSEGMENT segment);
|
|
|
|
// Move a path's current point.
|
|
//
|
|
// path - the handle to the path object.
|
|
// x - the horizontal position of the new current point.
|
|
// y - the vertical position of the new current point.
|
|
//
|
|
// Note that no line will be created between the previous current point and the
|
|
// new one.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_MoveTo(FPDF_PAGEOBJECT path,
|
|
float x,
|
|
float y);
|
|
|
|
// Add a line between the current point and a new point in the path.
|
|
//
|
|
// path - the handle to the path object.
|
|
// x - the horizontal position of the new point.
|
|
// y - the vertical position of the new point.
|
|
//
|
|
// The path's current point is changed to (x, y).
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_LineTo(FPDF_PAGEOBJECT path,
|
|
float x,
|
|
float y);
|
|
|
|
// Add a cubic Bezier curve to the given path, starting at the current point.
|
|
//
|
|
// path - the handle to the path object.
|
|
// x1 - the horizontal position of the first Bezier control point.
|
|
// y1 - the vertical position of the first Bezier control point.
|
|
// x2 - the horizontal position of the second Bezier control point.
|
|
// y2 - the vertical position of the second Bezier control point.
|
|
// x3 - the horizontal position of the ending point of the Bezier curve.
|
|
// y3 - the vertical position of the ending point of the Bezier curve.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_BezierTo(FPDF_PAGEOBJECT path,
|
|
float x1,
|
|
float y1,
|
|
float x2,
|
|
float y2,
|
|
float x3,
|
|
float y3);
|
|
|
|
// Close the current subpath of a given path.
|
|
//
|
|
// path - the handle to the path object.
|
|
//
|
|
// This will add a line between the current point and the initial point of the
|
|
// subpath, thus terminating the current subpath.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_Close(FPDF_PAGEOBJECT path);
|
|
|
|
// Set the drawing mode of a path.
|
|
//
|
|
// path - the handle to the path object.
|
|
// fillmode - the filling mode to be set: one of the FPDF_FILLMODE_* flags.
|
|
// stroke - a boolean specifying if the path should be stroked or not.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_SetDrawMode(FPDF_PAGEOBJECT path,
|
|
int fillmode,
|
|
FPDF_BOOL stroke);
|
|
|
|
// Experimental API.
|
|
// Get the drawing mode of a path.
|
|
//
|
|
// path - the handle to the path object.
|
|
// fillmode - the filling mode of the path: one of the FPDF_FILLMODE_* flags.
|
|
// stroke - a boolean specifying if the path is stroked or not.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_GetDrawMode(FPDF_PAGEOBJECT path,
|
|
int* fillmode,
|
|
FPDF_BOOL* stroke);
|
|
|
|
// Experimental API.
|
|
// Get the transform matrix of a path.
|
|
//
|
|
// path - handle to a path.
|
|
// matrix - pointer to struct to receive the matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and used to scale, rotate, shear and translate the path.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_GetMatrix(FPDF_PAGEOBJECT path,
|
|
FS_MATRIX* matrix);
|
|
|
|
// Experimental API.
|
|
// Set the transform matrix of a path.
|
|
//
|
|
// path - handle to a path.
|
|
// matrix - pointer to struct with the matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and can be used to scale, rotate, shear and translate the path.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPath_SetMatrix(FPDF_PAGEOBJECT path,
|
|
const FS_MATRIX* matrix);
|
|
|
|
// Create a new text object using one of the standard PDF fonts.
|
|
//
|
|
// document - handle to the document.
|
|
// font - string containing the font name, without spaces.
|
|
// font_size - the font size for the new text object.
|
|
//
|
|
// Returns a handle to a new text object, or NULL on failure
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV
|
|
FPDFPageObj_NewTextObj(FPDF_DOCUMENT document,
|
|
FPDF_BYTESTRING font,
|
|
float font_size);
|
|
|
|
// Set the text for a textobject. If it had text, it will be replaced.
|
|
//
|
|
// text_object - handle to the text object.
|
|
// text - the UTF-16LE encoded string containing the text to be added.
|
|
//
|
|
// Returns TRUE on success
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFText_SetText(FPDF_PAGEOBJECT text_object, FPDF_WIDESTRING text);
|
|
|
|
// Returns a font object loaded from a stream of data. The font is loaded
|
|
// into the document.
|
|
//
|
|
// document - handle to the document.
|
|
// data - the stream of data, which will be copied by the font object.
|
|
// size - size of the stream, in bytes.
|
|
// font_type - FPDF_FONT_TYPE1 or FPDF_FONT_TRUETYPE depending on the font
|
|
// type.
|
|
// cid - a boolean specifying if the font is a CID font or not.
|
|
//
|
|
// The loaded font can be closed using FPDFFont_Close.
|
|
//
|
|
// Returns NULL on failure
|
|
FPDF_EXPORT FPDF_FONT FPDF_CALLCONV FPDFText_LoadFont(FPDF_DOCUMENT document,
|
|
const uint8_t* data,
|
|
uint32_t size,
|
|
int font_type,
|
|
FPDF_BOOL cid);
|
|
|
|
// Experimental API.
|
|
// Loads one of the standard 14 fonts per PDF spec 1.7 page 416. The preferred
|
|
// way of using font style is using a dash to separate the name from the style,
|
|
// for example 'Helvetica-BoldItalic'.
|
|
//
|
|
// document - handle to the document.
|
|
// font - string containing the font name, without spaces.
|
|
//
|
|
// The loaded font can be closed using FPDFFont_Close.
|
|
//
|
|
// Returns NULL on failure.
|
|
FPDF_EXPORT FPDF_FONT FPDF_CALLCONV
|
|
FPDFText_LoadStandardFont(FPDF_DOCUMENT document, FPDF_BYTESTRING font);
|
|
|
|
// Experimental API.
|
|
// Get the transform matrix of a text object.
|
|
//
|
|
// text - handle to a text.
|
|
// matrix - pointer to struct with the matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and used to scale, rotate, shear and translate the text.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFTextObj_GetMatrix(FPDF_PAGEOBJECT text,
|
|
FS_MATRIX* matrix);
|
|
|
|
// Experimental API.
|
|
// Get the font size of a text object.
|
|
//
|
|
// text - handle to a text.
|
|
//
|
|
// Returns the font size of the text object, measured in points (about 1/72
|
|
// inch) on success; 0 on failure.
|
|
FPDF_EXPORT float FPDF_CALLCONV FPDFTextObj_GetFontSize(FPDF_PAGEOBJECT text);
|
|
|
|
// Close a loaded PDF font.
|
|
//
|
|
// font - Handle to the loaded font.
|
|
FPDF_EXPORT void FPDF_CALLCONV FPDFFont_Close(FPDF_FONT font);
|
|
|
|
// Create a new text object using a loaded font.
|
|
//
|
|
// document - handle to the document.
|
|
// font - handle to the font object.
|
|
// font_size - the font size for the new text object.
|
|
//
|
|
// Returns a handle to a new text object, or NULL on failure
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV
|
|
FPDFPageObj_CreateTextObj(FPDF_DOCUMENT document,
|
|
FPDF_FONT font,
|
|
float font_size);
|
|
|
|
// Experimental API.
|
|
// Get the text rendering mode of a text object.
|
|
//
|
|
// text - the handle to the text object.
|
|
//
|
|
// Returns one of the known FPDF_TEXT_RENDERMODE enum values on success,
|
|
// FPDF_TEXTRENDERMODE_UNKNOWN on error.
|
|
FPDF_EXPORT FPDF_TEXT_RENDERMODE FPDF_CALLCONV
|
|
FPDFTextObj_GetTextRenderMode(FPDF_PAGEOBJECT text);
|
|
|
|
// Experimental API.
|
|
// Set the text rendering mode of a text object.
|
|
//
|
|
// text - the handle to the text object.
|
|
// render_mode - the FPDF_TEXT_RENDERMODE enum value to be set (cannot set to
|
|
// FPDF_TEXTRENDERMODE_UNKNOWN).
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFTextObj_SetTextRenderMode(FPDF_PAGEOBJECT text,
|
|
FPDF_TEXT_RENDERMODE render_mode);
|
|
|
|
// Experimental API.
|
|
// Get the font name of a text object.
|
|
//
|
|
// text - the handle to the text object.
|
|
// buffer - the address of a buffer that receives the font name.
|
|
// length - the size, in bytes, of |buffer|.
|
|
//
|
|
// Returns the number of bytes in the font name (including the trailing NUL
|
|
// character) on success, 0 on error.
|
|
//
|
|
// Regardless of the platform, the |buffer| is always in UTF-8 encoding.
|
|
// If |length| is less than the returned length, or |buffer| is NULL, |buffer|
|
|
// will not be modified.
|
|
FPDF_EXPORT unsigned long FPDF_CALLCONV
|
|
FPDFTextObj_GetFontName(FPDF_PAGEOBJECT text,
|
|
void* buffer,
|
|
unsigned long length);
|
|
|
|
// Experimental API.
|
|
// Get the text of a text object.
|
|
//
|
|
// text_object - the handle to the text object.
|
|
// text_page - the handle to the text page.
|
|
// buffer - the address of a buffer that receives the text.
|
|
// length - the size, in bytes, of |buffer|.
|
|
//
|
|
// Returns the number of bytes in the text (including the trailing NUL
|
|
// character) on success, 0 on error.
|
|
//
|
|
// Regardless of the platform, the |buffer| is always in UTF-16LE encoding.
|
|
// If |length| is less than the returned length, or |buffer| is NULL, |buffer|
|
|
// will not be modified.
|
|
FPDF_EXPORT unsigned long FPDF_CALLCONV
|
|
FPDFTextObj_GetText(FPDF_PAGEOBJECT text_object,
|
|
FPDF_TEXTPAGE text_page,
|
|
void* buffer,
|
|
unsigned long length);
|
|
|
|
// Experimental API.
|
|
// Get number of page objects inside |form_object|.
|
|
//
|
|
// form_object - handle to a form object.
|
|
//
|
|
// Returns the number of objects in |form_object| on success, -1 on error.
|
|
FPDF_EXPORT int FPDF_CALLCONV
|
|
FPDFFormObj_CountObjects(FPDF_PAGEOBJECT form_object);
|
|
|
|
// Experimental API.
|
|
// Get page object in |form_object| at |index|.
|
|
//
|
|
// form_object - handle to a form object.
|
|
// index - the 0-based index of a page object.
|
|
//
|
|
// Returns the handle to the page object, or NULL on error.
|
|
FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV
|
|
FPDFFormObj_GetObject(FPDF_PAGEOBJECT form_object, unsigned long index);
|
|
|
|
// Experimental API.
|
|
// Get the transform matrix of a form object.
|
|
//
|
|
// form_object - handle to a form.
|
|
// matrix - pointer to struct to receive the matrix value.
|
|
//
|
|
// The matrix is composed as:
|
|
// |a c e|
|
|
// |b d f|
|
|
// and used to scale, rotate, shear and translate the form object.
|
|
//
|
|
// Returns TRUE on success.
|
|
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
|
|
FPDFFormObj_GetMatrix(FPDF_PAGEOBJECT form_object, FS_MATRIX* matrix);
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif // __cplusplus
|
|
|
|
#endif // PUBLIC_FPDF_EDIT_H_
|