ComPDFKit Objective-C SDK
API Reference Documentation for ComPDFKit Objective-C SDK
Loading...
Searching...
No Matches
base_type.h
1#import <Foundation/Foundation.h>
2
4typedef NS_ENUM(NSInteger, OCRLanguage) {
6 OCRLanguageUnknown = 0,
8 OCRLanguageChinese,
10 OCRLanguageChineseTraditional,
12 OCRLanguageEnglish,
14 OCRLanguageKorean,
16 OCRLanguageJapanese,
18 OCRLanguageLatin,
20 OCRLanguageDevanagari,
22 OCRLanguageAuto
23};
24
26typedef NS_ENUM(NSInteger, ErrorCode) {
28 ErrorCodeSuccess = 0,
30 ErrorCodeCancel = 1,
32 ErrorCodeFile = 2,
34 ErrorCodePDFPassword = 3,
36 ErrorCodePDFPage = 4,
38 ErrorCodePDFFormat = 5,
40 ErrorCodePDFSecurity = 6,
42 ErrorCodeOutOfMemory = 7,
44 ErrorCodeIO = 8,
46 ErrorCodeCompress = 9,
47
49 ErrorCodeLicenseInvalid = 20,
51 ErrorCodeLicenseExpire = 21,
53 ErrorCodeLicenseUnsupportedPlatform = 22,
55 ErrorCodeLicenseUnsupportedID = 23,
57 ErrorCodeLicenseUnsupportedDevice = 24,
59 ErrorCodeLicensePermissionDeny = 25,
61 ErrorCodeLicenseUninitialized = 26,
63 ErrorCodeLicenseIllegalAccess = 27,
65 ErrorCodeLicenseFileReadFailed = 28,
67 ErrorCodeLicenseOCRPermissionDeny = 29,
68
70 ErrorCodeNoTable = 40,
72 ErrorCodeOCRFailure = 41,
73
75 ErrorCodeConverting = 60,
76
78 ErrorCodeUnknown = 100
79};
80
82typedef NS_ENUM(NSInteger, PageLayoutMode) {
84 PageLayoutModeBox,
86 PageLayoutModeFlow
87};
88
90typedef NS_ENUM(NSInteger, ImageColorMode) {
92 ImageColorModeColor,
94 ImageColorModeGray,
96 ImageColorModeBinary
97};
98
100typedef NS_ENUM(NSInteger, ImageType) {
102 ImageTypeJPG,
104 ImageTypeJPEG,
106 ImageTypePNG,
108 ImageTypeBMP,
110 ImageTypeTIFF
111};
112
114typedef NS_ENUM(NSInteger, ExcelWorksheetOption){
116 ExcelWorksheetForTable,
118 ExcelWorksheetForPage,
120 ExcelWorksheetForDocument
121};
122
124typedef NS_ENUM(NSInteger, htmlPageOption){
126 HtmlOptionSinglePage,
128 HtmlOptionSinglePageWithBookmark,
130 HtmlOptionMultiPage,
132 HtmlOptionMultiPageWithBookmark,
133};
134
136@interface ConvertOptions : NSObject
137
139@property (nonatomic, assign) BOOL enableAILayout;
140
142@property (nonatomic, assign) BOOL containImage;
143
145@property (nonatomic, assign) BOOL jsonContainTable;
146
148@property (nonatomic, assign) BOOL containAnnotation;
149
151@property (nonatomic, assign) BOOL excelAllContent;
152
154@property (nonatomic, assign) ExcelWorksheetOption excelWorksheetOption;
155
157@property (nonatomic, assign) BOOL excelCSVFormat;
158
160@property (nonatomic, assign) BOOL enableOCR;
161
163@property (nonatomic, assign) BOOL txtTableFormat;
164
166@property (nonatomic, assign) BOOL imagePathEnhance;
167
169@property (nonatomic, assign) float imageScaling;
170
172@property (nonatomic, assign) BOOL formulaToImage;
173
175@property (nonatomic, assign) htmlPageOption htmlPageOption;
176
178@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
179
181@property (nonatomic, assign) ImageColorMode imageColorMode;
182
184@property (nonatomic, assign) ImageType imageType;
185
187@property (nonatomic, copy) NSString *pageRanges;
188
189@end
190
192@interface WordOptions : NSObject
193
195@property (nonatomic, assign) BOOL enableAILayout;
196
198@property (nonatomic, assign) BOOL containImage;
199
201@property (nonatomic, assign) BOOL formulaToImage;
202
204@property (nonatomic, assign) BOOL containAnnotation;
205
207@property (nonatomic, assign) BOOL enableOCR;
208
210@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
211
213@property (nonatomic, copy) NSString *pageRanges;
214
215@end
216
218@interface ExcelOptions : NSObject
219
221@property (nonatomic, assign) BOOL enableAILayout;
222
224@property (nonatomic, assign) BOOL containImage;
225
227@property (nonatomic, assign) BOOL formulaToImage;
228
230@property (nonatomic, assign) BOOL containAnnotation;
231
233@property (nonatomic, assign) BOOL enableOCR;
234
236@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
237
239@property (nonatomic, copy) NSString *pageRanges;
240
242@property (nonatomic, assign) BOOL CSVFormat;
243
245@property (nonatomic, assign) BOOL AllContent;
246
248@property (nonatomic, assign) ExcelWorksheetOption excelWorksheetOption;
249
250@end
251
253@interface PptOptions : NSObject
254
256@property (nonatomic, assign) BOOL enableAILayout;
257
259@property (nonatomic, assign) BOOL containImage;
260
262@property (nonatomic, assign) BOOL formulaToImage;
263
265@property (nonatomic, assign) BOOL containAnnotation;
266
268@property (nonatomic, assign) BOOL enableOCR;
269
271@property (nonatomic, copy) NSString *pageRanges;
272
273@end
274
276@interface HtmlOptions : NSObject
277
279@property (nonatomic, assign) BOOL enableAILayout;
280
282@property (nonatomic, assign) BOOL containImage;
283
285@property (nonatomic, assign) BOOL formulaToImage;
286
288@property (nonatomic, assign) BOOL containAnnotation;
289
291@property (nonatomic, assign) BOOL enableOCR;
292
294@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
295
297@property (nonatomic, assign) htmlPageOption htmlPageOption;
298
300@property (nonatomic, copy) NSString *pageRanges;
301
302@end
303
305@interface RtfOptions : NSObject
306
308@property (nonatomic, assign) BOOL enableAILayout;
309
311@property (nonatomic, assign) BOOL containImage;
312
314@property (nonatomic, assign) BOOL formulaToImage;
315
317@property (nonatomic, assign) BOOL containAnnotation;
318
320@property (nonatomic, assign) BOOL enableOCR;
321
323@property (nonatomic, copy) NSString *pageRanges;
324
325@end
326
328@interface ImageOptions : NSObject
329
331@property (nonatomic, assign) ImageColorMode ColorMode;
332
334@property (nonatomic, assign) ImageType Type;
335
337@property (nonatomic, assign) BOOL PathEnhance;
338
340@property (nonatomic, assign) float Scaling;
341
343@property (nonatomic, copy) NSString *pageRanges;
344
345@end
346
348@interface TxtOptions : NSObject
349
351@property (nonatomic, assign) BOOL enableAILayout;
352
354@property (nonatomic, assign) BOOL enableOCR;
355
357@property (nonatomic, copy) NSString *pageRanges;
358
360@property (nonatomic, assign) BOOL TableFormat;
361
362@end
363
365@interface JsonOptions : NSObject
366
368@property (nonatomic, assign) BOOL enableAILayout;
369
371@property (nonatomic, assign) BOOL containImage;
372
374@property (nonatomic, assign) BOOL containAnnotation;
375
377@property (nonatomic, assign) BOOL enableOCR;
378
380@property (nonatomic, copy) NSString *pageRanges;
381
383@property (nonatomic, assign) BOOL ContainTable;
384
385@end
386
388@interface SearchablePdfOptions : NSObject
389
391@property (nonatomic, assign) BOOL enableOCR;
392
394@property (nonatomic, assign) BOOL containImage;
395
397@property (nonatomic, assign) BOOL formulaToImage;
398
400@property (nonatomic, copy) NSString *pageRanges;
401
402@end
403
405@interface MarkdownOptions : NSObject
406
408@property (nonatomic, assign) BOOL enableOCR;
409
411@property (nonatomic, assign) BOOL containImage;
412
414@property (nonatomic, assign) BOOL containAnnotation;
415
417@property (nonatomic, copy) NSString *pageRanges;
418
420@property (nonatomic, assign) BOOL enableAILayout;
421
422@end
423
Convert options.
Definition base_type.h:137
BOOL excelCSVFormat
Whether to save as CSV format.
Definition base_type.h:157
ExcelWorksheetOption excelWorksheetOption
Whether each worksheet contains only one table.
Definition base_type.h:154
BOOL imagePathEnhance
Whether to enhance image paths.
Definition base_type.h:166
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:178
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:142
BOOL txtTableFormat
Whether to format tables when converting to TXT.
Definition base_type.h:163
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:160
htmlPageOption htmlPageOption
Specify the Html page option.
Definition base_type.h:175
ImageType imageType
Image file type.
Definition base_type.h:184
BOOL excelAllContent
Whether to export all content to Excel.
Definition base_type.h:151
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:187
ImageColorMode imageColorMode
Image color mode.
Definition base_type.h:181
BOOL jsonContainTable
Whether to include tables when converting to JSON.
Definition base_type.h:145
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:139
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:148
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:172
float imageScaling
Image scaling ratio.
Definition base_type.h:169
PDF to Excel conversion parameter object.
Definition base_type.h:219
BOOL AllContent
Whether to export all content to Excel.
Definition base_type.h:245
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:236
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:224
BOOL CSVFormat
Whether to save as CSV format.
Definition base_type.h:242
ExcelWorksheetOption excelWorksheetOption
Whether each worksheet contains only one table.
Definition base_type.h:248
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:230
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:239
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:227
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:221
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:233
PDF to Html conversion parameter object.
Definition base_type.h:277
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:279
htmlPageOption htmlPageOption
html page option
Definition base_type.h:297
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:288
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:282
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:291
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:285
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:294
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:300
PDF to Image conversion parameter object.
Definition base_type.h:329
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:343
ImageType Type
Image file type.
Definition base_type.h:334
ImageColorMode ColorMode
Image color mode.
Definition base_type.h:331
float Scaling
Image scaling ratio.
Definition base_type.h:340
BOOL PathEnhance
Whether to enhance image paths.
Definition base_type.h:337
PDF to Json conversion parameter object.
Definition base_type.h:366
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:380
BOOL ContainTable
Whether to include tables when converting to JSON.
Definition base_type.h:383
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:374
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:368
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:371
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:377
PDF to Markdown conversion parameter object.
Definition base_type.h:406
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:408
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:414
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:411
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:420
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:417
PDF to PPT conversion parameter object.
Definition base_type.h:254
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:268
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:256
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:259
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:265
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:271
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:262
PDF to RTF conversion parameter object.
Definition base_type.h:306
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:323
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:317
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:311
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:320
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:314
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:308
PDF to SearchablePdf conversion parameter object.
Definition base_type.h:389
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:400
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:397
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:394
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:391
PDF to TXT conversion parameter object.
Definition base_type.h:349
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:357
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:354
BOOL TableFormat
Whether to format tables when converting to TXT.
Definition base_type.h:360
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:351
PDF to Word conversion parameter object.
Definition base_type.h:193
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:198
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:195
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:201
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:204
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:207
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:210
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:213