Foxit PDF SDK  9.1
FSCompareResults Class Reference
Inheritance diagram for FSCompareResults:

Instance Methods

(void) - clear
 Clear all the result information.
More...
 
(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 
(id) - initWithBase_doc_results:compared_doc_results:
 Constructor, with parameters.
More...
 
(id) - initWithCompare_results:
 Constructor, with another compare results object.
More...
 
(id) - initWithCptr:swigOwnCObject:
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

FSCompareResultInfoArraybase_doc_results
 A result information array, which contains all the compared results of a PDF page (which has been compared) in the base document.
More...
 
FSCompareResultInfoArraycompared_doc_results
 A result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document.
More...
 

Detailed Description

This class contains all the results of a comparison process, including the results in both base document and compared document. This class is used as the return type of function FSComparison::doCompare:compared_page_index:compare_flags:.

See also
FSComparison .

Method Documentation

◆ clear

- (void) clear

Clear all the result information.

Returns
None.

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

◆ initWithBase_doc_results:compared_doc_results:

- (id) initWithBase_doc_results: (FSCompareResultInfoArray*)  base_doc_results
compared_doc_results: (FSCompareResultInfoArray*)  compared_doc_results 

Constructor, with parameters.

Parameters
[in]base_doc_resultsCompare results of base document.
[in]compared_doc_resultsCompare results of compared document.

◆ initWithCompare_results:

- (id) initWithCompare_results: (FSCompareResults*)  compare_results

Constructor, with another compare results object.

Parameters
[in]compare_resultsAnother compare results object.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ base_doc_results

- (FSCompareResultInfoArray *) base_doc_results
readwritenonatomiccopy

A result information array, which contains all the compared results of a PDF page (which has been compared) in the base document.

◆ compared_doc_results

- (FSCompareResultInfoArray *) compared_doc_results
readwritenonatomiccopy

A result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document.