Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsImage2Pdf.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsImage2Pdf.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_PDFTOOLSIMAGE2PDF_H__
20#define PDFTOOLS_PDFTOOLSIMAGE2PDF_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
57/******************************************************************************
58 * Auto
59 *****************************************************************************/
69
95 TPdfToolsGeomUnits_Size* pMaxPageSize);
121 const TPdfToolsGeomUnits_Size* pMaxPageSize);
141 TPdfToolsImage2Pdf_Auto* pAuto, TPdfToolsGeomUnits_Margin* pDefaultPageMargin);
161 TPdfToolsImage2Pdf_Auto* pAuto, const TPdfToolsGeomUnits_Margin* pDefaultPageMargin);
162
163/******************************************************************************
164 * ShrinkToPage
165 *****************************************************************************/
175
225 TPdfToolsImage2Pdf_ShrinkToPage* pShrinkToPage, const TPdfToolsGeomUnits_Size* pPageSize);
265 TPdfToolsImage2Pdf_ShrinkToPage* pShrinkToPage, const TPdfToolsGeomUnits_Margin* pPageMargin);
266
267/******************************************************************************
268 * ShrinkToFit
269 *****************************************************************************/
279
325 TPdfToolsImage2Pdf_ShrinkToFit* pShrinkToFit, const TPdfToolsGeomUnits_Size* pPageSize);
365 TPdfToolsImage2Pdf_ShrinkToFit* pShrinkToFit, const TPdfToolsGeomUnits_Margin* pPageMargin);
366
367/******************************************************************************
368 * ShrinkToPortrait
369 *****************************************************************************/
379
403 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, TPdfToolsGeomUnits_Size* pPageSize);
427 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, const TPdfToolsGeomUnits_Size* pPageSize);
448 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, TPdfToolsGeomUnits_Margin* pPageMargin);
469 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, const TPdfToolsGeomUnits_Margin* pPageMargin);
470
471/******************************************************************************
472 * ImageOptions
473 *****************************************************************************/
515
516/******************************************************************************
517 * Converter
518 *****************************************************************************/
528
575 TPdfToolsPdf_OutputOptions* pOutOptions);
622 TPdfToolsPdf_OutputOptions* pOutOptions);
623
624#ifdef __cplusplus
625}
626#endif
627
628#endif /* PDFTOOLS_PDFTOOLSIMAGE2PDF_H__ */
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_GetPageSize(TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, TPdfToolsGeomUnits_Size *pPageSize)
The page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_SetPageSize(TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, const TPdfToolsGeomUnits_Size *pPageSize)
The page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_GetDefaultPageMargin(TPdfToolsImage2Pdf_Auto *pAuto, TPdfToolsGeomUnits_Margin *pDefaultPageMargin)
The default page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_ConvertMultiple(TPdfToolsImage2Pdf_Converter *pConverter, TPdfToolsImage_DocumentList *pImages, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsImage2PdfProfiles_Profile *pProfile, TPdfToolsPdf_OutputOptions *pOutOptions)
Convert a list of images to a PDF document.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_GetPageMargin(TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, TPdfToolsGeomUnits_Margin *pPageMargin)
The page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToFit *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_New(void)
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToPage *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_New(void)
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_Auto *PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_SetPageSize(TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, const TPdfToolsGeomUnits_Size *pPageSize)
The page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_GetPageSize(TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, TPdfToolsGeomUnits_Size *pPageSize)
The page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_GetPageSize(TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, TPdfToolsGeomUnits_Size *pPageSize)
The page size.
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ImageMapping *PDFTOOLS_CALL PdfToolsImage2Pdf_ImageOptions_GetMapping(TPdfToolsImage2Pdf_ImageOptions *pImageOptions)
The image mapping.
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ImageMappingType PDFTOOLS_CALL PdfToolsImage2Pdf_ImageMapping_GetType(TPdfToolsImage2Pdf_ImageMapping *pImageMapping)
Get actual derived type of base type TPdfToolsImage2Pdf_ImageMapping.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_SetDefaultPageMargin(TPdfToolsImage2Pdf_Auto *pAuto, const TPdfToolsGeomUnits_Margin *pDefaultPageMargin)
The default page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToPortrait *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_SetPageMargin(TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, const TPdfToolsGeomUnits_Margin *pPageMargin)
The page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_SetMaxPageSize(TPdfToolsImage2Pdf_Auto *pAuto, const TPdfToolsGeomUnits_Size *pMaxPageSize)
The maximum page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_GetPageMargin(TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, TPdfToolsGeomUnits_Margin *pPageMargin)
The page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_GetMaxPageSize(TPdfToolsImage2Pdf_Auto *pAuto, TPdfToolsGeomUnits_Size *pMaxPageSize)
The maximum page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ImageOptions_SetMapping(TPdfToolsImage2Pdf_ImageOptions *pImageOptions, TPdfToolsImage2Pdf_ImageMapping *pMapping)
The image mapping.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_SetPageMargin(TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, const TPdfToolsGeomUnits_Margin *pPageMargin)
The page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_SetPageSize(TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, const TPdfToolsGeomUnits_Size *pPageSize)
The page size.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_SetPageMargin(TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, const TPdfToolsGeomUnits_Margin *pPageMargin)
The page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_Convert(TPdfToolsImage2Pdf_Converter *pConverter, TPdfToolsImage_Document *pImage, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsImage2PdfProfiles_Profile *pProfile, TPdfToolsPdf_OutputOptions *pOutOptions)
Convert an image to a PDF document.
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsImage2Pdf.h:26
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_GetPageMargin(TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, TPdfToolsGeomUnits_Margin *pPageMargin)
The page margin Default value: 20mm (0.79in)
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_Converter *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_New(void)
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
TPdfToolsImage2Pdf_ImageMappingType
Type and subtype enumeration of TPdfToolsImage2Pdf_ImageMapping.
Definition PdfTools_Types.h:2024
#define BOOL
Definition PdfTools_Types.h:23
The image mapping that automatically determines a suitable conversion.
The class to convert one or more images to a PDF document.
The base class for image mappings The image mapping specifies how an input image is transformed and p...
The conversion options related to the images.
The image mapping that places the image onto pages of the specified size Place images onto portrait o...
The image mapping that places the image onto pages of the specified size Place images onto portrait o...
The image mapping that places the image onto portrait pages of the specified size Place images onto p...
The base class for image to PDF conversion profiles A profile implements the conversion settings suit...
The base class for image documents Image documents are either opened using PdfToolsImage_Document_Ope...
List of image 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 ...
Definition PdfTools_Types.h:3342
Definition PdfTools_Types.h:3328
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49