/*!
**
** \file ptbDocumentsAPDFL.h
**
** \brief callas pdfEngine SDK: Documents actions - APDFL interface
**
** \author © 2009-2011 callas software GmbH, Berlin, Germany - www.callassoftware.com
**
*/

/******************************************************************************/

#if !defined(PTB_DOCUMENTS_APDFL_H)
/*! \def PTB_DOCUMENTS_APDFL_H header define */
#define PTB_DOCUMENTS_APDFL_H

/******************************************************************************/

#include "ptbTypes.h"
#include "ptbProgress.h"

/******************************************************************************/

#include "ptbProlog.h"

/******************************************************************************/

/* include PRODUCT file for Acrobat library definition. */
#include "HFTLibrary.h"

/* needed to define type of PDDoc */
#include "PDBasicExpT.h"

/******************************************************************************/

/*******************************************************************************
** Documents
*/

/*!
** \brief Overlay
**        Places the chosen content on top of the processed PDF.
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocOverlay( PDDoc                    src                 /*!< PDF document */
                , const PTB_Path_t*        overlayFile         /*!< Full path to PDF to put on top of the input PDF */
                , enum PTB_EPlacement      placement           /*!< Placement of the pages */
                , PTB_float_t              hoffset             /*!< Horizontal offset from placement in point */
                , PTB_float_t              voffset             /*!< Vertical offset from placement in point */
                , const PTB_Path_t*        dest                /*!< Destination path (including file name) */
                , PTB_ProgressCB           cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                , void*                    cbProgressUserData  /*!< User data submitted to progress callback function */
                );


/*!
** \brief  Extract XMP Metadata
**         Extract XMP Metadata of the processed PDF into a configurable XML file.
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocExtractXMPMetadata( PDDoc                    src                 /*!< PDF document */
                           , const PTB_Path_t*        cfg                 /*!< Path to configuration file(including file name) */
                           , const PTB_Path_t*        dest                /*!< Destination path (including file name) */
                           , PTB_ProgressCB           cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                           , void*                    cbProgressUserData  /*!< User data submitted to progress callback function */
                           );

/*!
** \brief  Create a visualizer report
**         
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocVisualizer( PDDoc                            src                 /*!< PDF document */
                   , enum PTB_EVisualizerFormat       format              /*!< PDF or Images */
                   , enum PTB_ESmallObjectsThreshold  smlobj              /*!< threshold for small object coverage highlighting */
                   , PTB_uint32_t                     inkcov              /*!< threshold for ink coverage highlighting in % */
                   , PTB_uint32_t                     bmpres              /*!< threshold for bitmap resolution highlighting in ppi */
                   , PTB_uint32_t                     imgres              /*!< threshold for image resolution highlighting in ppi */
                   , PTB_uint32_t                     parts               /*!< which parts (any combination of PTB_EVisualizerParts values) */
                   , PTB_uint32_t                     resolution          /*!< Resolution in ppi (e.g. 72) - only applied if 'format' is PTB_eImage */
                   , PTB_uint32_t                     width               /*!< width in pixel - only applied if 'format' is PTB_eImage and 'resolution' equal 0 */
                   , PTB_uint32_t                     height              /*!< height in pixel - only applied if 'format' is PTB_eImage and 'resolution' equal 0 */
                   , PTB_uint32_t                     firstPage           /*!< First page, this is a zero based index, i.e. first page has value of 0 (zero) */
                   , PTB_uint32_t                     lastPage            /*!< Last page; might be PTB_MAX_END_PAGE for all pages */
                   , const PTB_Path_t*                destFolder          /*!< Destination folder path (including folder name) */
                   , PTB_CreatedFileCB                cbVisualizer        /*!< Callback function to be called for every created file, might be NULL */
                   , void*                            cbVisualizerData    /*!< User data submitted to callback function */
                   , PTB_ProgressCB                   cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                   , void*                            cbProgressUserData  /*!< User data submitted to progress callback function */
                   );

/*!
** \brief  Extract text from PDF
**         Extract text from PDF into a text file
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocExtractText( PDDoc                 src                 /*!< PDF document */
                    , const PTB_Path_t*     dest                /*!< Destination path (including file name) */
                    , PTB_ProgressCB        cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                    , void*                 cbProgressUserData  /*!< User data submitted to progress callback function */
                    );

/*!
** \brief  Extract content from PDF
**         Extract content from PDF into a XML file
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocExtractContent( PDDoc                 src                 /*!< PDF document */
                       , enum PTB_EContentParts parts               /*!< which parts (any combination of PTB_EContentParts values) */
                       , const PTB_Path_t*      dest                /*!< Destination path (including file name) */
                       , PTB_ProgressCB         cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                       , void*                  cbProgressUserData  /*!< User data submitted to progress callback function */
                       );

/*!
** \brief  Re-Distill
**         Recreates the PDF via PostScript, prepares for use with older equipment (RIPs)
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocRedistill( PDDoc                 src                 /*!< PDF document */
                  , const PTB_Path_t*     pdfsetting          /*!< Full path to the PDF setting file (*.joboption), might be NULL to use default */
                  , const PTB_Path_t*     dest                /*!< Destination path (including file name) */
                  , PTB_ProgressCB        cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                  , void*                 cbProgressUserData  /*!< User data submitted to progress callback function */
                  );

/*!
** \brief  Compare
**         Compare two PDF documents and creates a differences report
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocCompare( PDDoc                 src1                /*!< PDF Document */
                , PDDoc                 src2                /*!< PDF Document to compare with */
                , enum PTB_ESensitivity sensitivity         /*!< Highlighting sensitivity */
                , PTB_CompareCB         cbCompare           /*!< CB function to save the PDF report file, might be NULL */
                , void*                 cbCompareUserData   /*!< User data submitted to PTB_CompareCB callback function */
                , PTB_ProgressCB        cbProgress          /*!< Progress CB function to be called during processing, might be NULL */
                , void*                 cbProgressUserData  /*!< User data submitted to progress callback function */
                );

/*******************************************************************************/

#include "ptbEpilog.h"

/******************************************************************************/

#endif /*PTB_DOCUMENTS_APDFL_H*/

/******************************************************************************/
/* EOF */