Foxit PDF SDK

Public Member Functions | List of all members
foxit::addon::pageeditor::ReplaceCallback Class Referenceabstract

## Public Member Functions
virtual bool | NeedToReplace (const WString &search_text, const WString &replace_text, int current_page_index, const RectFArray &text_rect_array)=0
| A callback function to verify whether need to replace text. More...
virtual void | Release ()=0
| A callback function used to release current callback object itself. More...

## Detailed Description

This class represents a callback object for replacing. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

## Member Function Documentation

## ◆ NeedToReplace()

virtual bool foxit::addon::pageeditor::ReplaceCallback::NeedToReplace | ( | const WString & | search_text,
|  | const WString & | replace_text,
|  | int | current_page_index,
|  | const RectFArray & | text_rect_array
| ) |  |
| pure virtual

A callback function to verify whether need to replace text.

Parameters

  [in] | search_text | The search text. It will not be empty.
  [in] | replace_text | The text will be replaced with. It will not be empty.
  [in] | current_page_index | The current page index.Valid range: from 0 to (count-1). count is returned by function PDFDoc::GetPageCount for PDF document.
  [in] | text_rect_array | The found text rect array.

Returns
  true means to replace, while false means not.

## ◆ Release()

virtual void foxit::addon::pageeditor::ReplaceCallback::Release | ( |  | ) |
| pure virtual

A callback function used to release current callback object itself.

Returns
  None.