Foxit PDF SDK

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

Inherits <NSObject>.

## Instance Methods
(BOOL) | - needToPause
| A callback function used to pause the current splitting progress. More...
(void) | - progressNotify:after_split_file_path:split_page_count:total_page_count:
| A callback function used to notify the current splitting progress. More...
(void) | - resultNotify:
| A callback function used to notify the current split result. More...

## Detailed Description

This class represents a callback object used to pause and notify the splitting progress during the splitting process, as well as to notify the result of the split. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

## Method Documentation

## ◆ needToPause()

- (BOOL) needToPause |  |  |
| required

A callback function used to pause the current splitting progress.

Returns
  true means to pause now, while false means not to pause now.

## ◆ progressNotify:after_split_file_path:split_page_count:total_page_count:()

- (void) progressNotify: |  | (NSString *) | before_splitting_file_name
after_split_file_path: |  | (NSString *) | after_split_file_path
split_page_count: |  | (int) | split_page_count
total_page_count: |  | (int) | total_page_count
| required

A callback function used to notify the current splitting progress.

Parameters

  [in] | before_splitting_file_name | The file name of the original PDF document before splitting.
  [in] | after_split_file_path | The file path of the PDF document generated by splitting.
  [in] | split_page_count | The count of pages to be split in the current PDF document.
  [in] | total_page_count | The total count of pages in the current PDF documen.

Returns
  None.

## ◆ resultNotify:()

- (void) resultNotify: |  | (FSSplitFileResultArray *) | result_array |
| required

A callback function used to notify the current split result.

Parameters

  [in] | result_array | An array of FSSplitFileResult objects. When the splitting is completed, the result information of each file split will be notified.

Returns
  None.