Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsImage.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsImage.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_PDFTOOLSIMAGE_H__
20#define PDFTOOLS_PDFTOOLSIMAGE_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 * Page
44 *****************************************************************************/
83
84/******************************************************************************
85 * PageList
86 *****************************************************************************/
116 int iIndex);
117
118/******************************************************************************
119 * Document
120 *****************************************************************************/
144
171/******************************************************************************
172 * SinglePageDocument
173 *****************************************************************************/
189
190/******************************************************************************
191 * MultiPageDocument
192 *****************************************************************************/
207
208/******************************************************************************
209 * DocumentList
210 *****************************************************************************/
220
268 TPdfToolsImage_Document* pDocument);
269
270#ifdef __cplusplus
271}
272#endif
273
274#endif /* PDFTOOLS_PDFTOOLSIMAGE_H__ */
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_Document_Close(TPdfToolsImage_Document *pObject)
Close object.
PDFTOOLS_EXPORT TPdfToolsImage_Document *PDFTOOLS_CALL PdfToolsImage_Document_Open(const TPdfToolsSys_StreamDescriptor *pStreamDesc)
Open an image document Documents opened with this method are read-only and cannot be modified.
PDFTOOLS_EXPORT TPdfToolsImage_Document *PDFTOOLS_CALL PdfToolsImage_DocumentList_Get(TPdfToolsImage_DocumentList *pDocumentList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_DocumentList_Add(TPdfToolsImage_DocumentList *pDocumentList, TPdfToolsImage_Document *pDocument)
Add an element to the end of the list.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_Page_GetResolution(TPdfToolsImage_Page *pPage, TPdfToolsGeomUnits_Resolution *pResolution)
The resolution of the page The resolution can be NULL if the image does not specify a resolution.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsImage_PageList_GetCount(TPdfToolsImage_PageList *pPageList)
Get the number of elements in the list.
PDFTOOLS_EXPORT TPdfToolsImage_DocumentList *PDFTOOLS_CALL PdfToolsImage_DocumentList_New(void)
PDFTOOLS_EXPORT TPdfToolsImage_PageList *PDFTOOLS_CALL PdfToolsImage_MultiPageDocument_GetPages(TPdfToolsImage_MultiPageDocument *pMultiPageDocument)
The pages of the image.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsImage_DocumentList_GetCount(TPdfToolsImage_DocumentList *pDocumentList)
Get the number of elements in the list.
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsImage.h:26
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_Page_GetSize(TPdfToolsImage_Page *pPage, TPdfToolsGeomInt_Size *pSize)
The size of the page in number of pixels.
PDFTOOLS_EXPORT TPdfToolsImage_Page *PDFTOOLS_CALL PdfToolsImage_SinglePageDocument_GetPage(TPdfToolsImage_SinglePageDocument *pSinglePageDocument)
The page of the image.
PDFTOOLS_EXPORT TPdfToolsImage_Page *PDFTOOLS_CALL PdfToolsImage_PageList_Get(TPdfToolsImage_PageList *pPageList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLS_EXPORT TPdfToolsImage_DocumentType PDFTOOLS_CALL PdfToolsImage_Document_GetType(TPdfToolsImage_Document *pDocument)
Get actual derived type of base type TPdfToolsImage_Document.
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
TPdfToolsImage_DocumentType
Type and subtype enumeration of TPdfToolsImage_Document.
Definition PdfTools_Types.h:1900
#define BOOL
Definition PdfTools_Types.h:23
The base class for image documents Image documents are either opened using PdfToolsImage_Document_Ope...
List of image documents.
The image document of an image format that supports multi-page images This class is used for TIFF ima...
The page of an image document.
The list of image pages.
The image document of an image format that only supports single-page images This class is used for th...
Definition PdfTools_Types.h:3300
Definition PdfTools_Types.h:3314
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49