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

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

#if !defined(PTB_LAYERS_APDFL_H)
/*! \def PTB_LAYERS_APDFL_H header define */
#define PTB_LAYERS_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"

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

/*******************************************************************************
** Layers
*/

/*!
** \brief Enumarate layers
**        Enumerate the chosen objects on separate layers.
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocEnumerateLayers( PDDoc                    src                 /*!< PDF document */
                        , PTB_bool_t               spotnames           /*!< Creates a layer for each spot color in the PDF */
                        , PTB_bool_t               fontnames           /*!< Creates a layer for each font in the PDF */
                        , PTB_bool_t               iccnames            /*!< Creates a layer for each ICC profile in the PDF */
                        , 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  Import as layer
**         Imports the chosen PDF document as a layer in the processed PDF.
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocImportAsLayer( PDDoc                    src                 /*!< PDF document */
                      , const PTB_Path_t*        importFile          /*!< Full path to a PDF to be imported */
                      , const PTB_utf8_char_t*   layername           /*!< Name of the new layer */
                      , 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  Split layers
**         Splits layers/layer views into single PDFs
**         with just the content of the layers/layer views.
**
*/
PTB_FUNC_PROTO 
enum PTB_EError 
PTB_PDDocSplitLayers( PDDoc                    src                   /*!< PDF document */
                    , PTB_bool_t               singlePages           /*!< Create one new file per page */
                    , const PTB_Path_t*        destFolder            /*!< Destination folder path (including folder name) */
                    , PTB_SplitLayersCB        cbSplitLayers         /*!< Callback function to be called for every created PDF, might be NULL */
                    , void*                    cbSplitLayersUserData /*!< User data submitted to callback function */
                    , PTB_ProgressCB           cbProgress            /*!< Progress Callback function to be called during processing, might be NULL */
                    , void*                    cbProgressUserData    /*!< User data submitted to progress callback function */
                    );

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

#include "ptbEpilog.h"

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

#endif /*PTB_LAYERS_APDFL_H*/

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