Foxit PDF SDK

Instance Methods | List of all members
<FSParagraphEditingProviderCallback> Protocol Reference

Inherits <NSObject>.

## Instance Methods
(void) | - addUndoItem:
| A callback function used to notify the page to add undo operation. More...
(FSRectF *) | - getClientRect:
| A callback function get the client rectangle in device coordinate system. More...
(int) | - getCurrentPageIndex:
| A callback function used to get current page index. More...
(FSRectF *) | - getPageRect:page_index:
| A callback function used to get page rectangle in device coordinate system. More...
(void *) | - getPageViewHandle:page_index:
| A callback function to get the page view window handle. More...
(FSRectF *) | - getPageVisibleRect:page_index:
| A callback function used to get visible page rectangle in device coordinate system. More...
(FSMatrix2D *) | - getRenderMatrix:page_index:
| A callback function get the render matrix. More...
(FSRotation) | - getRotation:page_index:
| A callback function used to get the page view rotate. More...
(float) | - getScale:page_index:
| A callback function get the scale of page. More...
(NSArray< NSNumber * > *) | - getVisiblePageIndexArray:
| A callback function used to get visible page indexes. More...
(BOOL) | - gotoPageView:page_index:left:top:
| A callback function to go to page view. More...
(void) | - invalidateRect:page_index:invalid_rects:
| A callback function used to invalidate page rectangle. More...
(void) | - notifyTextInputReachLimit:page_index:
| A callback function used to notify text input reach limit. More...
(void) | - setDocChangeMark:
| A callback function used to notify the document have changed. More...

## Detailed Description

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

## Method Documentation

## ◆ addUndoItem:()

- (void) addUndoItem: |  | (FSParagraphEditingUndoItem *) | undo_item |
| required

A callback function used to notify the page to add undo operation.

Parameters

  [in] | undo_item | The undo item object.

Returns
  None.

## ◆ getClientRect:()

- (FSRectF*) getClientRect: |  | (FSPDFDoc *) | document |
| required

A callback function get the client rectangle in device coordinate system.

Parameters

  [in] | document | The valid pdf document.

Returns
  The client rectangle.

## ◆ getCurrentPageIndex:()

- (int) getCurrentPageIndex: |  | (FSPDFDoc *) | document |
| required

A callback function used to get current page index.

Parameters

  [in] | document | The valid pdf document.

Returns
  The page index.

## ◆ getPageRect:page_index:()

- (FSRectF*) getPageRect: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function used to get page rectangle in device coordinate system.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.

Returns
  The page rectangle.

## ◆ getPageViewHandle:page_index:()

- (void*) getPageViewHandle: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function to get the page view window handle.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.

Returns
  The page view window handle.

## ◆ getPageVisibleRect:page_index:()

- (FSRectF*) getPageVisibleRect: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function used to get visible page rectangle in device coordinate system.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.

Returns
  The page visble rectangle.

## ◆ getRenderMatrix:page_index:()

- (FSMatrix2D*) getRenderMatrix: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function get the render matrix.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | A valid editor page object.

Returns
  The matrix.

## ◆ getRotation:page_index:()

- (FSRotation) getRotation: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function used to get the page view rotate.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.

Returns
  The indent value.

## ◆ getScale:page_index:()

- (float) getScale: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function get the scale of page.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.

Returns
  The scale value. The returned value should be greater than 0.

## ◆ getVisiblePageIndexArray:()

- (NSArray<NSNumber *> *) getVisiblePageIndexArray: |  | (FSPDFDoc *) | document |
| required

A callback function used to get visible page indexes.

Parameters

  [in] | document | The valid pdf document.

Returns
  The visble page index array.

## ◆ gotoPageView:page_index:left:top:()

- (BOOL) gotoPageView: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
left: |  | (float) | left
top: |  | (float) | top
| required

A callback function to go to page view.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.
  [in] | left | The left point where left mouse button is up in the page, in pdf coordination system.
  [in] | top | The top point where left mouse button is up in the page, in pdf coordination system.

Returns
  true means successful, while false means not.

## ◆ invalidateRect:page_index:invalid_rects:()

- (void) invalidateRect: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
invalid_rects: |  | (FSRectFArray *) | invalid_rects
| required

A callback function used to invalidate page rectangle.

Parameters

  [in] | document | The valid pdf document.
  [in] | page_index | The page index.
  [in] | rects | The invalid areas. The rectangle in invalid_rects is in device coordination system.

Returns
  None.

## ◆ notifyTextInputReachLimit:page_index:()

- (void) notifyTextInputReachLimit: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

A callback function used to notify text input reach limit.

Parameters

  [in] | document | The valid pdf document.
  [in] | editor_page | The editor page.

Returns
  None.

## ◆ setDocChangeMark:()

- (void) setDocChangeMark: |  | (FSPDFDoc *) | document |
| required

A callback function used to notify the document have changed.

Parameters

  [in] | document | The valid pdf document.

Returns
  None.