ComPDF Objective-C SDK
API Reference Documentation for ComPDF 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 = 1,
10 OCRLanguageChineseTraditional = 2,
12 OCRLanguageEnglish = 3,
14 OCRLanguageKorean = 4,
16 OCRLanguageJapanese = 5,
18 OCRLanguageLatin = 6,
20 OCRLanguageDevanagari = 7,
22 OCRLanguageCyrillic = 8,
24 OCRLanguageArabic = 9,
26 OCRLanguageTamil = 10,
28 OCRLanguageTelugu = 11,
30 OCRLanguageKannada = 12,
32 OCRLanguageThai = 13,
34 OCRLanguageGreek = 14,
36 OCRLanguageEslav = 15,
38 OCRLanguageAuto = 16
39};
40
42typedef NS_ENUM(NSInteger, ErrorCode) {
44 ErrorCodeSuccess = 0,
46 ErrorCodeCancel = 1,
48 ErrorCodeFile = 2,
50 ErrorCodePDFPassword = 3,
52 ErrorCodePDFPage = 4,
54 ErrorCodePDFFormat = 5,
56 ErrorCodePDFSecurity = 6,
58 ErrorCodeOutOfMemory = 7,
60 ErrorCodeIO = 8,
62 ErrorCodeCompress = 9,
63
65 ErrorCodeLicenseInvalid = 20,
67 ErrorCodeLicenseExpire = 21,
69 ErrorCodeLicenseUnsupportedPlatform = 22,
71 ErrorCodeLicenseUnsupportedID = 23,
73 ErrorCodeLicenseUnsupportedDevice = 24,
75 ErrorCodeLicensePermissionDeny = 25,
77 ErrorCodeLicenseUninitialized = 26,
79 ErrorCodeLicenseIllegalAccess = 27,
81 ErrorCodeLicenseFileReadFailed = 28,
83 ErrorCodeLicenseOCRPermissionDeny = 29,
84
86 ErrorCodeNoTable = 40,
88 ErrorCodeOCRFailure = 41,
89
91 ErrorCodeConverting = 60,
92
94 ErrorCodeInvalidArg = 80,
95
97 ErrorCodeInvalidHandle = 81,
98
100 ErrorCodeModelInvalidFormat = 82,
101
103 ErrorCodeModelFunctionUnsupported = 83,
104
106 ErrorCodeModelFormatUnsupported = 84,
107
109 ErrorCodeModelSDKMismatch = 85,
110
112 ErrorCodeImageDataEmpty = 86,
113
115 ErrorCodeImageWHError = 87,
116
118 ErrorCodeImageUnsupportedFormat = 88,
119
121 ErrorCodeImageInvalid = 89,
122
124 ErrorCodeExpire = 90,
125
127 ErrorCodeMissingArg = 91,
128
130 ErrorCodeLicenseUnsupportedAPI = 92,
131
133 ErrorCodeLicenseMismatch = 93,
134
136 ErrorCodeInvalidTable = 94,
137
139 ErrorCodeUnknown = 100
140};
141
143typedef NS_ENUM(NSInteger, PageLayoutMode) {
145 PageLayoutModeBox,
147 PageLayoutModeFlow
148};
149
151typedef NS_ENUM(NSInteger, ImageColorMode) {
153 ImageColorModeColor,
155 ImageColorModeGray,
157 ImageColorModeBinary
158};
159
161typedef NS_ENUM(NSInteger, ImageType) {
163 ImageTypeJPG,
165 ImageTypeJPEG,
167 ImageTypeJPEG2000,
169 ImageTypePNG,
171 ImageTypeBMP,
173 ImageTypeTIFF,
175 ImageTypeTGA,
177 ImageTypeGIF,
179 ImageTypeWEBP
180};
181
183typedef NS_ENUM(NSInteger, ExcelWorksheetOption){
185 ExcelWorksheetForTable,
187 ExcelWorksheetForPage,
189 ExcelWorksheetForDocument
190};
191
193typedef NS_ENUM(NSInteger, htmlPageOption){
195 HtmlOptionSinglePage,
197 HtmlOptionSinglePageWithBookmark,
199 HtmlOptionMultiPage,
201 HtmlOptionMultiPageWithBookmark,
202};
203
205typedef NS_ENUM(NSInteger, OCROption) {
207 OCROptionInvalidCharacter,
209 OCROptionScanPage,
211 OCROptionInvalidCharacterAndScanPage,
213 OCROptionAll,
214};
215
217@interface ConvertOptions : NSObject
218
220@property (nonatomic, assign) BOOL enableAILayout;
221
223@property (nonatomic, assign) BOOL containImage;
224
226@property (nonatomic, assign) BOOL contain_page_background_image;
227
229@property (nonatomic, assign) BOOL jsonContainTable;
230
232@property (nonatomic, assign) BOOL containAnnotation;
233
235@property (nonatomic, assign) BOOL excelAllContent;
236
238@property (nonatomic, assign) ExcelWorksheetOption excelWorksheetOption;
239
241@property (nonatomic, assign) BOOL excelCSVFormat;
242
244@property (nonatomic, assign) BOOL enableOCR;
245
247@property (nonatomic, assign) BOOL txtTableFormat;
248
250@property (nonatomic, assign) BOOL imagePathEnhance;
251
253@property (nonatomic, assign) float imageScaling;
254
256@property (nonatomic, assign) BOOL formulaToImage;
257
259@property (nonatomic, assign) BOOL auto_create_folder;
260
262@property (nonatomic, assign) BOOL output_document_per_page;
263
265@property (nonatomic, assign) OCROption ocrOption;
266
268@property (nonatomic, assign) htmlPageOption htmlPageOption;
269
271@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
272
274@property (nonatomic, assign) ImageColorMode imageColorMode;
275
277@property (nonatomic, assign) ImageType imageType;
278
280@property (nonatomic, copy) NSString *pageRanges;
281
282@end
283
285@interface WordOptions : NSObject
286
288@property (nonatomic, assign) BOOL enableAILayout;
289
291@property (nonatomic, assign) BOOL containImage;
292
294@property (nonatomic, assign) BOOL formulaToImage;
295
297@property (nonatomic, assign) BOOL containAnnotation;
298
300@property (nonatomic, assign) BOOL enableOCR;
301
303@property (nonatomic, assign) BOOL contain_page_background_image;
304
306@property (nonatomic, assign) BOOL output_document_per_page;
307
309@property (nonatomic, assign) OCROption ocrOption;
310
312@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
313
315@property (nonatomic, copy) NSString *pageRanges;
316
317@end
318
320@interface ExcelOptions : NSObject
321
323@property (nonatomic, assign) BOOL enableAILayout;
324
326@property (nonatomic, assign) BOOL containImage;
327
329@property (nonatomic, assign) BOOL formulaToImage;
330
332@property (nonatomic, assign) BOOL containAnnotation;
333
335@property (nonatomic, assign) BOOL enableOCR;
336
338@property (nonatomic, assign) BOOL auto_create_folder;
339
341@property (nonatomic, assign) BOOL output_document_per_page;
342
344@property (nonatomic, assign) OCROption ocrOption;
345
347@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
348
350@property (nonatomic, copy) NSString *pageRanges;
351
353@property (nonatomic, assign) BOOL CSVFormat;
354
356@property (nonatomic, assign) BOOL AllContent;
357
359@property (nonatomic, assign) ExcelWorksheetOption excelWorksheetOption;
360
361@end
362
364@interface PptOptions : NSObject
365
367@property (nonatomic, assign) BOOL enableAILayout;
368
370@property (nonatomic, assign) BOOL containImage;
371
373@property (nonatomic, assign) BOOL formulaToImage;
374
376@property (nonatomic, assign) BOOL containAnnotation;
377
379@property (nonatomic, assign) BOOL enableOCR;
380
382@property (nonatomic, assign) BOOL contain_page_background_image;
383
385@property (nonatomic, assign) BOOL output_document_per_page;
386
388@property (nonatomic, assign) OCROption ocrOption;
389
391@property (nonatomic, copy) NSString *pageRanges;
392
393@end
394
396@interface HtmlOptions : NSObject
397
399@property (nonatomic, assign) BOOL enableAILayout;
400
402@property (nonatomic, assign) BOOL containImage;
403
405@property (nonatomic, assign) BOOL formulaToImage;
406
408@property (nonatomic, assign) BOOL containAnnotation;
409
411@property (nonatomic, assign) BOOL enableOCR;
412
414@property (nonatomic, assign) BOOL contain_page_background_image;
415
417@property (nonatomic, assign) BOOL output_document_per_page;
418
420@property (nonatomic, assign) OCROption ocrOption;
421
423@property (nonatomic, assign) PageLayoutMode pageLayoutMode;
424
426@property (nonatomic, assign) htmlPageOption htmlPageOption;
427
429@property (nonatomic, copy) NSString *pageRanges;
430
431@end
432
434@interface RtfOptions : NSObject
435
437@property (nonatomic, assign) BOOL enableAILayout;
438
440@property (nonatomic, assign) BOOL containImage;
441
443@property (nonatomic, assign) BOOL formulaToImage;
444
446@property (nonatomic, assign) BOOL containAnnotation;
447
449@property (nonatomic, assign) BOOL enableOCR;
450
452@property (nonatomic, assign) BOOL contain_page_background_image;
453
455@property (nonatomic, assign) BOOL output_document_per_page;
456
458@property (nonatomic, assign) OCROption ocrOption;
459
461@property (nonatomic, copy) NSString *pageRanges;
462
463@end
464
466@interface ImageOptions : NSObject
467
469@property (nonatomic, assign) ImageColorMode ColorMode;
470
472@property (nonatomic, assign) ImageType Type;
473
475@property (nonatomic, assign) BOOL PathEnhance;
476
478@property (nonatomic, assign) float Scaling;
479
481@property (nonatomic, copy) NSString *pageRanges;
482
483@end
484
486@interface TxtOptions : NSObject
487
489@property (nonatomic, assign) BOOL enableAILayout;
490
492@property (nonatomic, assign) BOOL enableOCR;
493
495@property (nonatomic, assign) BOOL output_document_per_page;
496
498@property (nonatomic, assign) OCROption ocrOption;
499
501@property (nonatomic, copy) NSString *pageRanges;
502
504@property (nonatomic, assign) BOOL TableFormat;
505
506@end
507
509@interface JsonOptions : NSObject
510
512@property (nonatomic, assign) BOOL enableAILayout;
513
515@property (nonatomic, assign) BOOL containImage;
516
518@property (nonatomic, assign) BOOL containAnnotation;
519
521@property (nonatomic, assign) BOOL enableOCR;
522
524@property (nonatomic, assign) BOOL output_document_per_page;
525
527@property (nonatomic, assign) OCROption ocrOption;
528
530@property (nonatomic, copy) NSString *pageRanges;
531
533@property (nonatomic, assign) BOOL ContainTable;
534
535@end
536
538@interface SearchablePdfOptions : NSObject
539
541@property (nonatomic, assign) BOOL enableOCR;
542
544@property (nonatomic, assign) BOOL containImage;
545
547@property (nonatomic, assign) BOOL formulaToImage;
548
550@property (nonatomic, assign) BOOL contain_page_background_image;
551
553@property (nonatomic, assign) BOOL output_document_per_page;
554
556@property (nonatomic, assign) OCROption ocrOption;
557
559@property (nonatomic, copy) NSString *pageRanges;
560
561@end
562
564@interface MarkdownOptions : NSObject
565
567@property (nonatomic, assign) BOOL enableOCR;
568
570@property (nonatomic, assign) BOOL containImage;
571
573@property (nonatomic, assign) BOOL containAnnotation;
574
576@property (nonatomic, assign) BOOL output_document_per_page;
577
579@property (nonatomic, assign) OCROption ocrOption;
580
582@property (nonatomic, copy) NSString *pageRanges;
583
585@property (nonatomic, assign) BOOL enableAILayout;
586
587@end
588
Convert options.
Definition base_type.h:218
BOOL excelCSVFormat
Whether to save as CSV format.
Definition base_type.h:241
ExcelWorksheetOption excelWorksheetOption
Whether each worksheet contains only one table.
Definition base_type.h:238
BOOL imagePathEnhance
Whether to enhance image paths.
Definition base_type.h:250
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:271
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:223
BOOL txtTableFormat
Whether to format tables when converting to TXT.
Definition base_type.h:247
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:244
htmlPageOption htmlPageOption
Specify the Html page option.
Definition base_type.h:268
ImageType imageType
Image file type.
Definition base_type.h:277
BOOL excelAllContent
Whether to export all content to Excel.
Definition base_type.h:235
BOOL contain_page_background_image
Whether to contain page background images when converting,which takes effect only when enable_ocr is ...
Definition base_type.h:226
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:262
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:280
ImageColorMode imageColorMode
Image color mode.
Definition base_type.h:274
BOOL jsonContainTable
Whether to include tables when converting to JSON.
Definition base_type.h:229
BOOL auto_create_folder
Whether to automatically create folder when exporting multiple documents.
Definition base_type.h:259
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:220
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:232
OCROption ocrOption
OCR option scope.
Definition base_type.h:265
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:256
float imageScaling
Image scaling ratio.
Definition base_type.h:253
PDF to Excel conversion parameter object.
Definition base_type.h:321
BOOL AllContent
Whether to export all content to Excel.
Definition base_type.h:356
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:347
OCROption ocrOption
OCR option scope.
Definition base_type.h:344
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:326
BOOL auto_create_folder
Whether to automatically create folder when exporting multiple documents.
Definition base_type.h:338
BOOL CSVFormat
Whether to save as CSV format.
Definition base_type.h:353
ExcelWorksheetOption excelWorksheetOption
Whether each worksheet contains only one table.
Definition base_type.h:359
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:332
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:350
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:341
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:329
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:323
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:335
PDF to Html conversion parameter object.
Definition base_type.h:397
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:399
htmlPageOption htmlPageOption
html page option
Definition base_type.h:426
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:408
BOOL contain_page_background_image
Whether to contain page background images when converting,which takes effect only when enable_ocr is ...
Definition base_type.h:414
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:402
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:417
OCROption ocrOption
OCR option scope.
Definition base_type.h:420
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:411
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:405
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:423
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:429
PDF to Image conversion parameter object.
Definition base_type.h:467
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:481
ImageType Type
Image file type.
Definition base_type.h:472
ImageColorMode ColorMode
Image color mode.
Definition base_type.h:469
float Scaling
Image scaling ratio.
Definition base_type.h:478
BOOL PathEnhance
Whether to enhance image paths.
Definition base_type.h:475
PDF to Json conversion parameter object.
Definition base_type.h:510
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:530
BOOL ContainTable
Whether to include tables when converting to JSON.
Definition base_type.h:533
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:524
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:518
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:512
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:515
OCROption ocrOption
OCR option scope.
Definition base_type.h:527
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:521
PDF to Markdown conversion parameter object.
Definition base_type.h:565
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:567
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:573
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:576
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:570
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:585
OCROption ocrOption
OCR option scope.
Definition base_type.h:579
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:582
PDF to PPT conversion parameter object.
Definition base_type.h:365
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:379
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:367
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:370
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:376
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:391
BOOL contain_page_background_image
Whether to contain page background images when converting,which takes effect only when enable_ocr is ...
Definition base_type.h:382
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:385
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:373
OCROption ocrOption
OCR option scope.
Definition base_type.h:388
PDF to RTF conversion parameter object.
Definition base_type.h:435
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:461
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:446
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:440
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:449
OCROption ocrOption
OCR option scope.
Definition base_type.h:458
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:443
BOOL contain_page_background_image
Whether to contain page background images when converting,which takes effect only when enable_ocr is ...
Definition base_type.h:452
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:437
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:455
PDF to SearchablePdf conversion parameter object.
Definition base_type.h:539
BOOL contain_page_background_image
Whether to contain page background images when converting,which takes effect only when enable_ocr is ...
Definition base_type.h:550
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:559
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:547
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:544
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:541
OCROption ocrOption
OCR option scope.
Definition base_type.h:556
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:553
PDF to TXT conversion parameter object.
Definition base_type.h:487
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:501
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:492
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:495
OCROption ocrOption
OCR option scope.
Definition base_type.h:498
BOOL TableFormat
Whether to format tables when converting to TXT.
Definition base_type.h:504
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:489
PDF to Word conversion parameter object.
Definition base_type.h:286
OCROption ocrOption
OCR option scope.
Definition base_type.h:309
BOOL containImage
Whether to include images (only effective when OCR is disabled)
Definition base_type.h:291
BOOL contain_page_background_image
Whether to contain page background images when converting,which takes effect only when enable_ocr is ...
Definition base_type.h:303
BOOL enableAILayout
Whether to remove AI content during conversion.
Definition base_type.h:288
BOOL formulaToImage
Convert formulas to images.
Definition base_type.h:294
BOOL containAnnotation
Whether to include annotations.
Definition base_type.h:297
BOOL enableOCR
Whether to enable OCR.
Definition base_type.h:300
BOOL output_document_per_page
whether to output one document per page.
Definition base_type.h:306
PageLayoutMode pageLayoutMode
Page layout mode.
Definition base_type.h:312
NSString * pageRanges
Page ranges for conversion (e.g. "1-3,5,7-9")
Definition base_type.h:315