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 *****************************************************************************/
13
14#ifndef PDFTOOLS_PDFTOOLSIMAGE2PDF_H__
15#define PDFTOOLS_PDFTOOLSIMAGE2PDF_H__
16
17#ifndef PDFTOOLS_CALL
18#if defined(WIN32)
19#define PDFTOOLS_CALL __stdcall
20#else
21#define PDFTOOLS_CALL
22#endif
23#endif
24
25#include "PdfTools_Types.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#else
35#endif
36
52/******************************************************************************
53 * Auto
54 *****************************************************************************/
65
91 TPdfToolsGeomUnits_Size* pMaxPageSize);
117 const TPdfToolsGeomUnits_Size* pMaxPageSize);
137 TPdfToolsImage2Pdf_Auto* pAuto, TPdfToolsGeomUnits_Margin* pDefaultPageMargin);
157 TPdfToolsImage2Pdf_Auto* pAuto, const TPdfToolsGeomUnits_Margin* pDefaultPageMargin);
158
159/******************************************************************************
160 * ShrinkToPage
161 *****************************************************************************/
172
222 TPdfToolsImage2Pdf_ShrinkToPage* pShrinkToPage, const TPdfToolsGeomUnits_Size* pPageSize);
262 TPdfToolsImage2Pdf_ShrinkToPage* pShrinkToPage, const TPdfToolsGeomUnits_Margin* pPageMargin);
263
264/******************************************************************************
265 * ShrinkToFit
266 *****************************************************************************/
277
323 TPdfToolsImage2Pdf_ShrinkToFit* pShrinkToFit, const TPdfToolsGeomUnits_Size* pPageSize);
363 TPdfToolsImage2Pdf_ShrinkToFit* pShrinkToFit, const TPdfToolsGeomUnits_Margin* pPageMargin);
364
365/******************************************************************************
366 * ShrinkToPortrait
367 *****************************************************************************/
378
402 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, TPdfToolsGeomUnits_Size* pPageSize);
426 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, const TPdfToolsGeomUnits_Size* pPageSize);
447 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, TPdfToolsGeomUnits_Margin* pPageMargin);
468 TPdfToolsImage2Pdf_ShrinkToPortrait* pShrinkToPortrait, const TPdfToolsGeomUnits_Margin* pPageMargin);
469
470/******************************************************************************
471 * ImageOptions
472 *****************************************************************************/
515
516/******************************************************************************
517 * Converter
518 *****************************************************************************/
529
577 TPdfToolsPdf_OutputOptions* pOutOptions);
625 TPdfToolsPdf_OutputOptions* pOutOptions);
626
627#ifdef __cplusplus
628}
629#endif
630
631#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:21
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:138
struct TPdfToolsImage2Pdf_ImageMapping TPdfToolsImage2Pdf_ImageMapping
The base class for image mappings The image mapping specifies how an input image is transformed and p...
Definition PdfTools_Types.h:2641
struct TPdfToolsPdf_OutputOptions TPdfToolsPdf_OutputOptions
The parameters for document-level features of output PDFs Output options are used in many operations ...
Definition PdfTools_Types.h:2217
TPdfToolsImage2Pdf_ImageMappingType
Type and subtype enumeration of TPdfToolsImage2Pdf_ImageMapping.
Definition PdfTools_Types.h:1957
struct TPdfToolsImage2Pdf_ShrinkToPage TPdfToolsImage2Pdf_ShrinkToPage
The image mapping that places the image onto pages of the specified size Place images onto portrait o...
Definition PdfTools_Types.h:2664
struct TPdfToolsImage2PdfProfiles_Profile TPdfToolsImage2PdfProfiles_Profile
The base class for image to PDF conversion profiles A profile implements the conversion settings suit...
Definition PdfTools_Types.h:2695
struct TPdfToolsImage2Pdf_Converter TPdfToolsImage2Pdf_Converter
The class to convert one or more images to a PDF document.
Definition PdfTools_Types.h:2688
struct TPdfToolsImage2Pdf_ImageOptions TPdfToolsImage2Pdf_ImageOptions
The conversion options related to the images.
Definition PdfTools_Types.h:2684
struct TPdfToolsImage2Pdf_Auto TPdfToolsImage2Pdf_Auto
The image mapping that automatically determines a suitable conversion.
Definition PdfTools_Types.h:2655
struct TPdfToolsImage2Pdf_ShrinkToFit TPdfToolsImage2Pdf_ShrinkToFit
The image mapping that places the image onto pages of the specified size Place images onto portrait o...
Definition PdfTools_Types.h:2671
struct TPdfToolsImage_DocumentList TPdfToolsImage_DocumentList
List of image documents.
Definition PdfTools_Types.h:2326
struct TPdfToolsImage_Document TPdfToolsImage_Document
The base class for image documents Image documents are either opened using PdfToolsImage_Document_Ope...
Definition PdfTools_Types.h:2303
struct TPdfToolsImage2Pdf_ShrinkToPortrait TPdfToolsImage2Pdf_ShrinkToPortrait
The image mapping that places the image onto portrait pages of the specified size Place images onto p...
Definition PdfTools_Types.h:2680
#define BOOL
Definition PdfTools_Types.h:18
struct TPdfToolsPdf_Document TPdfToolsPdf_Document
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
Definition PdfTools_Types.h:2224
Definition PdfTools_Types.h:3152
Definition PdfTools_Types.h:3138
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:44