Foxit PDF SDK

Public Member Functions | List of all members
com.foxit.sdk.addon.ocr.OCRCallback Class Reference

## Public Member Functions
boolean | isImageIgnored (ImageObject image_object)
| A callback function used to determine whether an image object should be excluded from OCR text recognition. More...
boolean | needToCancelNow (String info)
| A callback function used to cancel current OCR progress. More...

## Detailed Description

This class represents a callback object to cancel OCR progress. All the pure virtual functions in this class are used as callback functions and should be implemented by user. An implemented OCRCallback object can be set by function OCREngine.setOCRCallback .

## Member Function Documentation

## ◆ isImageIgnored()

boolean com.foxit.sdk.addon.ocr.OCRCallback.isImageIgnored | ( | ImageObject | image_object | ) |

A callback function used to determine whether an image object should be excluded from OCR text recognition.

Parameters

  [in] | image_object | A pointer to an com.foxit.sdk.pdf.graphics.ImageObject object.

Returns
  true means to ignore the image object during OCR processing, the image will not be processed by the OCR engine for text extraction, but the image itself remains in the output document, while false means not.

## ◆ needToCancelNow()

boolean com.foxit.sdk.addon.ocr.OCRCallback.needToCancelNow | ( | String | info | ) |

A callback function used to cancel current OCR progress.

This function cannot be used to cancel OCR conversion.

Parameters

  [in] | info | A string that describes the OCR progress information.

Returns
  true means to cancel progress, while false means not.