- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DocumentConversion.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 // !Warning! This file is autogenerated, modify the .codegen file, not this one
6 // (any changes here will be wiped out during the autogen process)
7
8 #ifndef PDFTRON_H_CPPPDFDocumentConversion
9 #define PDFTRON_H_CPPPDFDocumentConversion
10 #include <C/PDF/TRN_DocumentConversion.h>
11
12 #include <Common/BasicTypes.h>
13 #include <Common/UString.h>
14 #include <PDF/PDFDoc.h>
15
16 namespace pdftron { namespace PDF {
17
18
26 class DocumentConversion
27 {
28 public:
29 enum Result {
30 eSuccess = 0,
31 eIncomplete = 1,
32 eFailure = 2
33 };
34 DocumentConversion();
35 DocumentConversion(const DocumentConversion& other);
36 DocumentConversion(TRN_DocumentConversion impl);
37 DocumentConversion& operator= (const DocumentConversion& other);
38 ~DocumentConversion();
39 void Destroy();
40
46 Result TryConvert();
47
52 void Convert();
53
58 void ConvertNextPage();
59
65 PDFDoc GetDoc();
66
72 Result GetConversionStatus() const;
73
78 void CancelConversion();
79
85 bool IsCancelled() const;
86
92 bool HasProgressTracking() const;
93
99 double GetProgress() const;
100
106 UString GetProgressLabel() const;
107
113 UInt32 GetNumConvertedPages() const;
114
120 UString GetErrorString() const;
121
127 UInt32 GetNumWarnings() const;
128
135 UString GetWarningString(UInt32 index) const;
136
142 UString GetCurrentExcelSheetName() const;
143
149 UInt32 GetNextExcelSheetCellCount() const;
150
155 void SkipNextExcelSheet();
156
157 //for xamarin use only
158 static DocumentConversion* CreateInternal(ptrdiff_t impl);
159 ptrdiff_t GetHandleInternal();
160
161
162
163 #ifndef SWIGHIDDEN
164 TRN_DocumentConversion m_impl;
165 #endif
166
167 private:
168
169 };
170
171 #include <Impl/DocumentConversion.inl>
172 } //end pdftron
173 } //end PDF
174
175
176 #endif //PDFTRON_H_CPPPDFDocumentConversion
pdftron::PDF::DocumentConversion::eIncomplete
Definition: DocumentConversion.h:31
pdftron::PDF::DocumentConversion::GetNumWarnings
UInt32 GetNumWarnings() const
pdftron::PDF::DocumentConversion::~DocumentConversion
~DocumentConversion()
pdftron::PDF::DocumentConversion::GetWarningString
UString GetWarningString(UInt32 index) const
pdftron::PDF::DocumentConversion::m_impl
TRN_DocumentConversion m_impl
Definition: DocumentConversion.h:164
pdftron::PDF::DocumentConversion::operator=
DocumentConversion & operator=(const DocumentConversion &other)
pdftron::PDF::DocumentConversion::eSuccess
Definition: DocumentConversion.h:30
UString.h
pdftron::PDF::DocumentConversion::SkipNextExcelSheet
void SkipNextExcelSheet()
pdftron::PDF::DocumentConversion::eFailure
Definition: DocumentConversion.h:32
pdftron::PDF::DocumentConversion::GetHandleInternal
ptrdiff_t GetHandleInternal()
pdftron::PDF::DocumentConversion::GetNextExcelSheetCellCount
UInt32 GetNextExcelSheetCellCount() const
pdftron::PDF::DocumentConversion
Definition: DocumentConversion.h:26
pdftron::PDF::DocumentConversion::GetNumConvertedPages
UInt32 GetNumConvertedPages() const
pdftron::PDF::DocumentConversion::CancelConversion
void CancelConversion()
pdftron::PDF::DocumentConversion::Destroy
void Destroy()
pdftron::PDF::PDFDoc
Definition: PDFDoc.h:71
pdftron::UInt32
TRN_UInt32 UInt32
Definition: BasicTypes.h:13
pdftron::PDF::DocumentConversion::CreateInternal
static DocumentConversion * CreateInternal(ptrdiff_t impl)
pdftron::PDF::DocumentConversion::GetErrorString
UString GetErrorString() const
PDFDoc.h
pdftron::PDF::DocumentConversion::DocumentConversion
DocumentConversion()
pdftron::PDF::DocumentConversion::Result
Result
Definition: DocumentConversion.h:29
pdftron::PDF::DocumentConversion::Convert
void Convert()
pdftron::PDF::DocumentConversion::GetProgressLabel
UString GetProgressLabel() const
BasicTypes.h
pdftron::PDF::DocumentConversion::GetDoc
PDFDoc GetDoc()
pdftron::PDF::DocumentConversion::GetCurrentExcelSheetName
UString GetCurrentExcelSheetName() const
pdftron::PDF::DocumentConversion::IsCancelled
bool IsCancelled() const
pdftron::PDF::DocumentConversion::GetConversionStatus
Result GetConversionStatus() const
pdftron::PDF::DocumentConversion::TryConvert
Result TryConvert()
pdftron::PDF::DocumentConversion::GetProgress
double GetProgress() const
pdftron::PDF::DocumentConversion::HasProgressTracking
bool HasProgressTracking() const
pdftron::PDF::DocumentConversion::ConvertNextPage
void ConvertNextPage()
pdftron::UString
Definition: UString.h:27