Foxit PDF SDK
|
Public Member Functions | |
OCR () | |
Constructor. | |
OCR (const OCR &other) | |
Constructor, with another ocr object. More... | |
~OCR () | |
Destructor. | |
OCRSuspectInfoArray | GetOCRSuspectsInfo (pdf::PDFDoc ocred_pdf_doc) |
Get OCR suspicious information. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
void | OCRPDFDocument (pdf::PDFDoc pdf_doc, bool is_editable) |
OCR each page of a PDF document. More... | |
void | OCRPDFDocument (pdf::PDFDoc pdf_doc, bool is_editable, const OCRConfig &config) |
OCR each page of a PDF document. More... | |
void | OCRPDFDocuments (const ocr::OCRSettingDataArray &settingdata_array) |
OCR multiple pages of multiple PDF documents. More... | |
void | OCRPDFPage (pdf::PDFPage pdf_page, bool is_editable) |
OCR a PDF page. More... | |
void | OCRPDFPage (pdf::PDFPage pdf_page, bool is_editable, const OCRConfig &config) |
OCR a PDF page. More... | |
bool | operator != (const OCR &other) const |
Not equal operator. More... | |
OCR & | operator= (const OCR &other) |
Assign operator. More... | |
bool | operator== (const OCR &other) const |
Equal operator. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class is used to do OCR for a PDF page or a PDF document. Please ensure OCR engine has been initialized before using this class.
foxit::addon::ocr::OCR::OCR | ( | const OCR & | other | ) |
Constructor, with another ocr object.
[in] | other | Another ocr object. |
OCRSuspectInfoArray foxit::addon::ocr::OCR::GetOCRSuspectsInfo | ( | pdf::PDFDoc | ocred_pdf_doc | ) |
Get OCR suspicious information.
The parameter ocred_pdf_doc is a valid PDF document that should have been ocred.
[in] | ocred_pdf_doc | A valid PDF document object. |
bool foxit::addon::ocr::OCR::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void foxit::addon::ocr::OCR::OCRPDFDocument | ( | pdf::PDFDoc | pdf_doc, |
bool | is_editable | ||
) |
OCR each page of a PDF document.
After this function succeeds, the PDF page content may be changed. It is better to parse or re-parse PDF pages in the input PDF document before using these pages.
[in] | pdf_doc | A valid PDF document object. |
[in] | is_editable | true means the OCR result is editable. false means the OCR result can only be searched but not be edited. |
void foxit::addon::ocr::OCR::OCRPDFDocument | ( | pdf::PDFDoc | pdf_doc, |
bool | is_editable, | ||
const OCRConfig & | config | ||
) |
OCR each page of a PDF document.
After this function succeeds, the PDF page content may be changed. It is better to parse or re-parse PDF pages in the input PDF document before using these pages.
[in] | pdf_doc | A valid PDF document object. |
[in] | is_editable | true means the OCR result is editable. false means the OCR result can only be searched but not be edited. |
[in] | config | The OCRConfig. |
void foxit::addon::ocr::OCR::OCRPDFDocuments | ( | const ocr::OCRSettingDataArray & | settingdata_array | ) |
OCR multiple pages of multiple PDF documents.
This function can be used to batch process multiple documents or pages. Users can set documents and page ranges via OCRSettingDataArray. The time performance of this function will be better than calling OCR::OCRPDFDocument or OCR::OCRPDFPage multiple times when dealing with a large number of documents or pages. After successful execution, the page content may be changed, it is better to parse or re-parse the PDF pages before using these pages.
[in] | settingdata_array | An array of OCRSettingData objects, if the parameter page_range of OCRSettingData object is empty, that means OCR each page of the PDF document. |
void foxit::addon::ocr::OCR::OCRPDFPage | ( | pdf::PDFPage | pdf_page, |
bool | is_editable | ||
) |
OCR a PDF page.
After this function succeeds, the PDF page content may be changed and the input PDF page is recommended to be re-parsed.
[in] | pdf_page | A valid PDF page object. This PDF page should have been parsed. |
[in] | is_editable | true means the OCR result is editable. false means the OCR result can only be searched but not be edit. |
void foxit::addon::ocr::OCR::OCRPDFPage | ( | pdf::PDFPage | pdf_page, |
bool | is_editable, | ||
const OCRConfig & | config | ||
) |
OCR a PDF page.
After this function succeeds, the PDF page content may be changed and the input PDF page is recommended to be re-parsed.
[in] | pdf_page | A vaild PDF page object. This PDF page should have been parsed. |
[in] | is_editable | true means the OCR result is editable. false means the OCR result can only be searched but not be edited. |
[in] | config | The OCRConfig. |
bool foxit::addon::ocr::OCR::operator != | ( | const OCR & | other | ) | const |
Not equal operator.
[in] | other | Another ocr object. This function will check if current object is not equal to this one. |
Assign operator.
[in] | other | Another ocr object, whose value would be assigned to current object. |
bool foxit::addon::ocr::OCR::operator== | ( | const OCR & | other | ) | const |
Equal operator.
[in] | other | Another ocr object. This function will check if current object is equal to this one. |