/*---------------------------------------------------------------------------*
| Copyright (c) 1997-2015 PDFlib GmbH. All rights reserved. |
+---------------------------------------------------------------------------+
| This software may not be copied or distributed except as expressly |
| authorized by PDFlib GmbH's general license agreement or a custom |
| license agreement signed by PDFlib GmbH. |
| For more information about licensing please refer to www.pdflib.com. |
*---------------------------------------------------------------------------*/
/* $Id: pdflib.h,v 1.418.2.48 2015/11/25 12:50:14 rjs Exp $
*
* Public function declarations for PDFlib, PDFlib+PDI, and PPS;
* see PDFlib API reference for details.
*
*/
#ifndef PDFLIB_H
#define PDFLIB_H
/* Make our declarations C++ compatible */
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
#include <setjmp.h>
#define PDFLIB_PRODUCTNAME "PDFlib"
/*
* The version defines below can be used to check the version of the
* include file against the library.
*/
#define PDFLIB_MAJORVERSION 9 /* major version number */
#define PDFLIB_MINORVERSION 0 /* minor version number */
#define PDFLIB_REVISION 6 /* revision number */
#define PDFLIB_SHORT_VERSIONSTRING "9" /* short version number */
#define PDFLIB_LONG_VERSIONSTRING "9.0.6" /* full version number*/
/*
* ----------------------------------------------------------------------
* Setup, mostly Windows calling conventions and DLL stuff
* ----------------------------------------------------------------------
*/
#if defined(WIN32) && !defined(PDFLIB_CALL)
#define PDFLIB_CALL __cdecl
#endif
#undef PDFLIB_API
#if defined(WIN32)
#ifdef PDFLIB_EXPORTS
#define PDFLIB_API __declspec(dllexport) /* prepare a DLL (internal use) */
#elif defined(PDFLIB_DLL)
#define PDFLIB_API __declspec(dllimport) /* PDFlib clients: import DLL */
#endif /* PDFLIB_DLL */
#else
#if __GNUC__ >= 4
#define PDFLIB_API __attribute__ ((visibility("default")))
#elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
|| (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
#define PDFLIB_API __global
#elif defined(HPUX_HIDDEN_DEF)
#define PDFLIB_API __declspec(dllexport)
#endif
#endif /* WIN32 */
#ifndef PDFLIB_CALL
#define PDFLIB_CALL /* */ /* default: no special calling conventions */
#endif
#ifndef PDFLIB_API
#define PDFLIB_API /* */ /* default: generate or use static library */
#endif
#if !defined(PDF) || defined(ACTIVEX)
typedef struct PDF_s PDF;
#endif /* !PDF */
/* The API structure with function pointers. */
typedef struct PDFlib_api_s PDFlib_api;
/* enums for the return values of unsupported function PDF_get_unicode_format()
*/
typedef enum
{
pdf_uni_none = 0, /* no Unicode format */
pdf_uni_utf8 = 5, /* UTF-8 */
pdf_uni_utf16 = 7, /* UTF-16 */
pdf_uni_utf16be = 8, /* UTF-16 BE */
pdf_uni_utf16le = 9, /* UTF-16 LE */
pdf_uni_utf32 = 10 /* UTF-32 */
}
pdf_unicode_format;
/*
* ----------------------------------------------------------------------
* Function prototypes for all supported API functions
* ----------------------------------------------------------------------
*/
/* Activate a previously created structure element or other content item. */
PDFLIB_API void PDFLIB_CALL
PDF_activate_item(PDF *p, int id);
/* Deprecated, use PDF_create_bookmark(). */
PDFLIB_API int PDFLIB_CALL
PDF_add_bookmark(PDF *p, const char *text, int parent, int open);
/* Deprecated, use PDF_create_bookmark(). */
PDFLIB_API int PDFLIB_CALL
PDF_add_bookmark2(PDF *p, const char *text, int len, int parent, int open);
/* Deprecated, use PDF_create_action() and PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_add_launchlink(PDF *p, double llx, double lly, double urx, double ury,
const char *filename);
/* Deprecated, use PDF_create_action() and PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_add_locallink(PDF *p, double llx, double lly, double urx, double ury,
int page, const char *optlist);
/* Create a named destination on a page in the document. */
PDFLIB_API void PDFLIB_CALL
PDF_add_nameddest(PDF *p, const char *name, int len, const char *optlist);
/* Deprecated, use PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_add_note(PDF *p, double llx, double lly, double urx, double ury,
const char *contents, const char *title, const char *icon, int open);
/* Deprecated, use PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_add_note2(PDF *p, double llx, double lly, double urx, double ury,
const char *contents, int len_cont, const char *title, int len_title,
const char *icon, int open);
/* Add a point to a new or existing path object.
Returns: A path handle which can be used in subsequent path-related calls.
*/
PDFLIB_API int PDFLIB_CALL
PDF_add_path_point(PDF *p, int path, double x, double y,
const char *type, const char *optlist);
/* Deprecated, use PDF_create_action() and PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_add_pdflink(PDF *p, double llx, double lly, double urx, double ury,
const char *filename, int page, const char *optlist);
/* Add a file to a portfolio folder or a package (requires PDF 1.7).
Returns: -1 (in PHP: 0) on error, and 1 otherwise.
*/
PDFLIB_API int PDFLIB_CALL
PDF_add_portfolio_file(PDF *p, int folder, const char *filename, int len,
const char *optlist);
/* Add a folder to a new or existing portfolio (requires PDF 1.7ext3).
Returns: A folder handle which can be used in subsequent
portfolio-related calls.
*/
PDFLIB_API int PDFLIB_CALL
PDF_add_portfolio_folder(PDF *p, int parent, const char *foldername, int len,
const char *optlist);
/* Add a cell to a new or existing table.
Returns: A table handle which can be used in subsequent table-related calls.
*/
PDFLIB_API int PDFLIB_CALL
PDF_add_table_cell(PDF *p, int table, int column, int row, const char *text,
int len, const char *optlist);
/* Create a Textflow object, or add text and explicit options to an existing
Textflow.
Returns: A Textflow handle, or -1 (in PHP: 0) on error.
*/
PDFLIB_API int PDFLIB_CALL
PDF_add_textflow(PDF *p, int textflow, const char *text, int len,
const char *optlist);
/* Add an image as thumbnail for the current page. */
PDFLIB_API void PDFLIB_CALL
PDF_add_thumbnail(PDF *p, int image);
/* Deprecated, use PDF_create_action() and PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_add_weblink(PDF *p, double llx, double lly, double urx, double ury,
const char *url);
/* Align the coordinate system with a relative vector. */
PDFLIB_API void PDFLIB_CALL
PDF_align(PDF *p, double dx, double dy);
/* Draw a counterclockwise circular arc segment. */
PDFLIB_API void PDFLIB_CALL
PDF_arc(PDF *p, double x, double y, double r, double alpha, double beta);
/* Draw a clockwise circular arc segment. */
PDFLIB_API void PDFLIB_CALL
PDF_arcn(PDF *p, double x, double y, double r, double alpha, double beta);
/* Deprecated, use PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_attach_file(PDF *p, double llx, double lly, double urx, double ury,
const char *filename, const char *description, const char *author,
const char *mimetype, const char *icon);
/* Deprecated, use PDF_create_annotation(). */
PDFLIB_API void PDFLIB_CALL
PDF_attach_file2(PDF *p, double llx, double lly, double urx, double ury,
const char *filename, int len_filename, const char *description,
int len_descr, const char *author, int len_auth, const char *mimetype,
const char *icon);
/* Create a new PDF document subject to various
