Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsDocumentAssembly.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsDocumentAssembly.h
4 *
5 * Description: Sub Header file for Pdftools SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_PDFTOOLSDOCUMENTASSEMBLY_H__
20#define PDFTOOLS_PDFTOOLSDOCUMENTASSEMBLY_H__
21
22#ifndef PDFTOOLS_CALL
23#if defined(WIN32)
24#define PDFTOOLS_CALL __stdcall
25#else
26#define PDFTOOLS_CALL
27#endif
28#endif
29
30#include "PdfTools_Types.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#else
40#endif
41
42/******************************************************************************
43 * PageCopyOptions
44 *****************************************************************************/
55
231 TPdfToolsDocumentAssembly_CopyStrategy iUnsignedSignatures);
322 TPdfToolsDocumentAssembly_PageCopyOptions* pPageCopyOptions, BOOL bCopyOutlineItems);
366 TPdfToolsDocumentAssembly_PageCopyOptions* pPageCopyOptions, BOOL bCopyAssociatedFiles);
414 TPdfToolsDocumentAssembly_PageCopyOptions* pPageCopyOptions, BOOL bCopyLogicalStructure);
461 TPdfToolsDocumentAssembly_NameConflictResolution iFormFieldConflictResolution);
552 TPdfToolsDocumentAssembly_PageCopyOptions* pPageCopyOptions, BOOL bOptimizeResources);
592
593/******************************************************************************
594 * DocumentCopyOptions
595 *****************************************************************************/
606
646 TPdfToolsDocumentAssembly_DocumentCopyOptions* pDocumentCopyOptions, BOOL bCopyMetadata);
686 TPdfToolsDocumentAssembly_DocumentCopyOptions* pDocumentCopyOptions, BOOL bCopyOutputIntent);
726 TPdfToolsDocumentAssembly_DocumentCopyOptions* pDocumentCopyOptions, BOOL bCopyViewerSettings);
770 TPdfToolsDocumentAssembly_DocumentCopyOptions* pDocumentCopyOptions, BOOL bCopyEmbeddedFiles);
771
772/******************************************************************************
773 * DocumentAssembler
774 *****************************************************************************/
806 TPdfToolsPdf_OutputOptions* pOutOptions,
807 const TPdfToolsPdf_Conformance* pConformance);
808
859 const int* pFirstPage, const int* pLastPage, TPdfToolsDocumentAssembly_DocumentCopyOptions* pDocumentCopyOptions,
883
896
897#ifdef __cplusplus
898}
899#endif
900
901#endif /* PDFTOOLS_PDFTOOLSDOCUMENTASSEMBLY_H__ */
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_NamedDestinationCopyStrategy PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetNamedDestinations(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy strategy for named destinations.
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_CopyStrategy PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetLinks(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy strategy for links.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_GetCopyOutputIntent(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetLinks(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_CopyStrategy iLinks)
Copy strategy for links.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetUnsignedSignatures(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_CopyStrategy iUnsignedSignatures)
Copy strategy for unsigned signature fields.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetOptimizeResources(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Find and merge redundant resources.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentAssembler_Append(TPdfToolsDocumentAssembly_DocumentAssembler *pDocumentAssembler, TPdfToolsPdf_Document *pInDoc, const int *pFirstPage, const int *pLastPage, TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions, TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetCopyLogicalStructure(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy the logical structure and tagging information.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_SetCopyMetadata(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions, BOOL bCopyMetadata)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetCopyOutlineItems(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, BOOL bCopyOutlineItems)
Copy outline items (bookmarks).
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentAssembler_Assemble(TPdfToolsDocumentAssembly_DocumentAssembler *pDocumentAssembler)
Assemble the input documents The input documents appended with PdfToolsDocumentAssembly_DocumentAssem...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_SetCopyOutputIntent(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions, BOOL bCopyOutputIntent)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetCopyLogicalStructure(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, BOOL bCopyLogicalStructure)
Copy the logical structure and tagging information.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_SetCopyEmbeddedFiles(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions, BOOL bCopyEmbeddedFiles)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetCopyAssociatedFiles(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, BOOL bCopyAssociatedFiles)
Copy associated files.
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_CopyStrategy PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetFormFields(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy strategy for form fields.
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_CopyStrategy PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetAnnotations(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy strategy for annotations.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_SetCopyViewerSettings(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions, BOOL bCopyViewerSettings)
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_RemovalStrategy PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetSignedSignatures(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Removal strategy for signed signature fields.
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_DocumentCopyOptions *PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_New(void)
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_PageCopyOptions *PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_New(void)
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_NameConflictResolution PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetFormFieldConflictResolution(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Resolution of conflicting form field names.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetPageRotation(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_PageRotation iPageRotation)
Specify how page(s) should be rotated.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetCopyOutlineItems(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy outline items (bookmarks).
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_GetCopyEmbeddedFiles(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions)
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_DocumentAssembler *PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentAssembler_New(const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsPdf_OutputOptions *pOutOptions, const TPdfToolsPdf_Conformance *pConformance)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_GetCopyViewerSettings(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetNamedDestinations(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_NamedDestinationCopyStrategy iNamedDestinations)
Copy strategy for named destinations.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetOptimizeResources(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, BOOL bOptimizeResources)
Find and merge redundant resources.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetFormFieldConflictResolution(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_NameConflictResolution iFormFieldConflictResolution)
Resolution of conflicting form field names.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentCopyOptions_GetCopyMetadata(TPdfToolsDocumentAssembly_DocumentCopyOptions *pDocumentCopyOptions)
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsDocumentAssembly.h:26
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetAnnotations(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_CopyStrategy iAnnotations)
Copy strategy for annotations.
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_CopyStrategy PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetUnsignedSignatures(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy strategy for unsigned signature fields.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetCopyAssociatedFiles(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Copy associated files.
PDFTOOLS_EXPORT TPdfToolsDocumentAssembly_PageRotation PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_GetPageRotation(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions)
Specify how page(s) should be rotated.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetFormFields(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_CopyStrategy iFormFields)
Copy strategy for form fields.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_DocumentAssembler_Close(TPdfToolsDocumentAssembly_DocumentAssembler *pObject)
Close object.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsDocumentAssembly_PageCopyOptions_SetSignedSignatures(TPdfToolsDocumentAssembly_PageCopyOptions *pPageCopyOptions, TPdfToolsDocumentAssembly_RemovalStrategy iSignedSignatures)
Removal strategy for signed signature fields.
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
TPdfToolsPdf_Conformance
Definition PdfTools_Types.h:198
TPdfToolsDocumentAssembly_NameConflictResolution
Definition PdfTools_Types.h:327
TPdfToolsDocumentAssembly_NamedDestinationCopyStrategy
Definition PdfTools_Types.h:309
TPdfToolsDocumentAssembly_PageRotation
Definition PdfTools_Types.h:343
TPdfToolsDocumentAssembly_RemovalStrategy
Definition PdfTools_Types.h:293
TPdfToolsDocumentAssembly_CopyStrategy
Definition PdfTools_Types.h:272
#define BOOL
Definition PdfTools_Types.h:23
The class for splitting or merging PDF documents.
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
The parameters for document-level features of output PDFs Output options are used in many operations ...
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49