Pdftools SDK
Loading...
Searching...
No Matches
include
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
*****************************************************************************/
13
14
#ifndef PDFTOOLS_PDFTOOLSIMAGE_H__
15
#define PDFTOOLS_PDFTOOLSIMAGE_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
"
26
#include "
PdfTools_PdfToolsSys.h
"
27
28
#ifdef __cplusplus
29
extern
"C"
30
{
31
#endif
32
33
#ifdef _UNICODE
34
#else
35
#endif
36
37
/******************************************************************************
38
* Page
39
*****************************************************************************/
56
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsImage_Page_GetSize
(
TPdfToolsImage_Page
* pPage,
TPdfToolsGeomInt_Size
* pSize);
76
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsImage_Page_GetResolution
(
TPdfToolsImage_Page
* pPage,
77
TPdfToolsGeomUnits_Resolution
* pResolution);
78
79
/******************************************************************************
80
* PageList
81
*****************************************************************************/
95
PDFTOOLS_EXPORT
int
PDFTOOLS_CALL
PdfToolsImage_PageList_GetCount
(
TPdfToolsImage_PageList
* pPageList);
112
PDFTOOLS_EXPORT
TPdfToolsImage_Page
*
PDFTOOLS_CALL
PdfToolsImage_PageList_Get
(
TPdfToolsImage_PageList
* pPageList,
113
int
iIndex);
114
115
/******************************************************************************
116
* Document
117
*****************************************************************************/
140
PDFTOOLS_EXPORT
TPdfToolsImage_Document
*
PDFTOOLS_CALL
141
PdfToolsImage_Document_Open
(
const
TPdfToolsSys_StreamDescriptor
* pStreamDesc);
142
156
PDFTOOLS_EXPORT
TPdfToolsImage_DocumentType
PDFTOOLS_CALL
157
PdfToolsImage_Document_GetType
(
TPdfToolsImage_Document
* pDocument);
168
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsImage_Document_Close
(
TPdfToolsImage_Document
* pObject);
169
/******************************************************************************
170
* SinglePageDocument
171
*****************************************************************************/
186
PDFTOOLS_EXPORT
TPdfToolsImage_Page
*
PDFTOOLS_CALL
187
PdfToolsImage_SinglePageDocument_GetPage
(
TPdfToolsImage_SinglePageDocument
* pSinglePageDocument);
188
189
/******************************************************************************
190
* MultiPageDocument
191
*****************************************************************************/
205
PDFTOOLS_EXPORT
TPdfToolsImage_PageList
*
PDFTOOLS_CALL
206
PdfToolsImage_MultiPageDocument_GetPages
(
TPdfToolsImage_MultiPageDocument
* pMultiPageDocument);
207
208
/******************************************************************************
209
* DocumentList
210
*****************************************************************************/
220
PDFTOOLS_EXPORT
TPdfToolsImage_DocumentList
*
PDFTOOLS_CALL
PdfToolsImage_DocumentList_New
(
void
);
221
235
PDFTOOLS_EXPORT
int
PDFTOOLS_CALL
PdfToolsImage_DocumentList_GetCount
(
TPdfToolsImage_DocumentList
* pDocumentList);
252
PDFTOOLS_EXPORT
TPdfToolsImage_Document
*
PDFTOOLS_CALL
253
PdfToolsImage_DocumentList_Get
(
TPdfToolsImage_DocumentList
* pDocumentList,
int
iIndex);
270
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsImage_DocumentList_Add
(
TPdfToolsImage_DocumentList
* pDocumentList,
271
TPdfToolsImage_Document
* pDocument);
272
273
#ifdef __cplusplus
274
}
275
#endif
276
277
#endif
/* PDFTOOLS_PDFTOOLSIMAGE_H__ */
PdfToolsImage_Document_Close
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_Document_Close(TPdfToolsImage_Document *pObject)
Close object.
PdfToolsImage_Document_Open
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.
PdfToolsImage_DocumentList_Get
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.
PdfToolsImage_DocumentList_Add
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_DocumentList_Add(TPdfToolsImage_DocumentList *pDocumentList, TPdfToolsImage_Document *pDocument)
Add an element to the end of the list.
PdfToolsImage_Page_GetResolution
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.
PdfToolsImage_PageList_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsImage_PageList_GetCount(TPdfToolsImage_PageList *pPageList)
Get the number of elements in the list.
PdfToolsImage_DocumentList_New
PDFTOOLS_EXPORT TPdfToolsImage_DocumentList *PDFTOOLS_CALL PdfToolsImage_DocumentList_New(void)
PdfToolsImage_MultiPageDocument_GetPages
PDFTOOLS_EXPORT TPdfToolsImage_PageList *PDFTOOLS_CALL PdfToolsImage_MultiPageDocument_GetPages(TPdfToolsImage_MultiPageDocument *pMultiPageDocument)
The pages of the image.
PdfToolsImage_DocumentList_GetCount
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsImage_DocumentList_GetCount(TPdfToolsImage_DocumentList *pDocumentList)
Get the number of elements in the list.
PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition
PdfTools_PdfToolsImage.h:21
PdfToolsImage_Page_GetSize
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage_Page_GetSize(TPdfToolsImage_Page *pPage, TPdfToolsGeomInt_Size *pSize)
The size of the page in number of pixels.
PdfToolsImage_SinglePageDocument_GetPage
PDFTOOLS_EXPORT TPdfToolsImage_Page *PDFTOOLS_CALL PdfToolsImage_SinglePageDocument_GetPage(TPdfToolsImage_SinglePageDocument *pSinglePageDocument)
The page of the image.
PdfToolsImage_PageList_Get
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.
PdfToolsImage_Document_GetType
PDFTOOLS_EXPORT TPdfToolsImage_DocumentType PDFTOOLS_CALL PdfToolsImage_Document_GetType(TPdfToolsImage_Document *pDocument)
Get actual derived type of base type TPdfToolsImage_Document.
PdfTools_PdfToolsSys.h
PDFTOOLS_EXPORT
#define PDFTOOLS_EXPORT
Definition
PdfTools_Platform.h:138
PdfTools_Types.h
TPdfToolsImage_MultiPageDocument
struct TPdfToolsImage_MultiPageDocument TPdfToolsImage_MultiPageDocument
The image document of an image format that supports multi-page images This class is used for TIFF ima...
Definition
PdfTools_Types.h:2322
TPdfToolsImage_DocumentType
TPdfToolsImage_DocumentType
Type and subtype enumeration of TPdfToolsImage_Document.
Definition
PdfTools_Types.h:1833
TPdfToolsImage_Page
struct TPdfToolsImage_Page TPdfToolsImage_Page
The page of an image document.
Definition
PdfTools_Types.h:2292
TPdfToolsImage_SinglePageDocument
struct TPdfToolsImage_SinglePageDocument TPdfToolsImage_SinglePageDocument
The image document of an image format that only supports single-page images This class is used for th...
Definition
PdfTools_Types.h:2316
TPdfToolsImage_DocumentList
struct TPdfToolsImage_DocumentList TPdfToolsImage_DocumentList
List of image documents.
Definition
PdfTools_Types.h:2326
TPdfToolsImage_PageList
struct TPdfToolsImage_PageList TPdfToolsImage_PageList
The list of image pages.
Definition
PdfTools_Types.h:2296
TPdfToolsImage_Document
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
BOOL
#define BOOL
Definition
PdfTools_Types.h:18
TPdfToolsGeomInt_Size
Definition
PdfTools_Types.h:3110
TPdfToolsGeomUnits_Resolution
Definition
PdfTools_Types.h:3124
TPdfToolsSys_StreamDescriptor
Structure that groups a set of callbacks that model streams.
Definition
PdfTools_PdfToolsSys.h:44
Generated by
1.10.0