Foxit PDF SDK
|
Public Types | |
enum | CompareType { e_CompareTypeAll = 0x00000000, e_CompareTypeText = 0x00000001, e_CompareTypeAnnotation = 0x00000002 } |
Enumeration for compare type flags. More... | |
Public Member Functions | |
Comparison (const Comparison &other) | |
Constructor, with another comparison object. More... | |
Comparison (const pdf::PDFDoc &base_doc, const pdf::PDFDoc &compared_doc) | |
Constructor, from PDF document object. More... | |
~Comparison () | |
Destructor. | |
CompareResults | DoCompare (int base_page_index, int compared_page_index, foxit::uint32 compare_flags) |
Compare a PDF page of base document with a PDF page in compared document. "base document" and "compared document" means the PDF documents objects that are used to construct current object. More... | |
pdf::PDFDoc | GenerateComparedDoc (foxit::uint32 compare_flags) |
Compare the base document with the compared document (which are used to construct current object) and then generate a PDF document as the comparison result. More... | |
pdf::PDFDoc | GenerateComparedDoc (foxit::uint32 compare_flags, bool is_show_all_layers) |
Compare the base document with the compared document (which are used to construct current object) and then generate a PDF document as the comparison result. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const Comparison &other) const |
Not equal operator. More... | |
Comparison & | operator= (const Comparison &other) |
Assign operator. More... | |
bool | operator== (const Comparison &other) const |
Equal operator. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class can be used to compare one PDF file (as "base document") with another PDF file (as "compared document") page by page.
|
explicit |
Constructor, from PDF document object.
[in] | base_doc | A valid PDF document object as base document. |
[in] | compared_doc | A valid PDF document object as compared document. |
foxit::addon::comparison::Comparison::Comparison | ( | const Comparison & | other | ) |
Constructor, with another comparison object.
[in] | other | Another comparison object. |
CompareResults foxit::addon::comparison::Comparison::DoCompare | ( | int | base_page_index, |
int | compared_page_index, | ||
foxit::uint32 | compare_flags | ||
) |
Compare a PDF page of base document with a PDF page in compared document. "base document" and "compared document" means the PDF documents objects that are used to construct current object.
[in] | base_page_index | Page index in base document. Valid range: from 0 to (base_page_count-1). base_page_count is returned by function pdf::PDFDoc::GetPageCount for base document. |
[in] | compared_page_index | Page index in compared document. Valid range: from 0 to (compared_page_count-1). compared_page_count is returned by function pdf::PDFDoc::GetPageCount for compared document. |
[in] | compare_flags | Compare type which specifies what to be compared in PDF pages. Please refer to values starting from Comparison::e_CompareTypeAll and this can be one or combination of some of these values. |
pdf::PDFDoc foxit::addon::comparison::Comparison::GenerateComparedDoc | ( | foxit::uint32 | compare_flags | ) |
Compare the base document with the compared document (which are used to construct current object) and then generate a PDF document as the comparison result.
Comparing the contents of two PDF documents and generating a new PDF document can take a long time.
[in] | compare_flags | Compare type which specifies what to be compared in PDF pages. Please refer to values starting from Comparison::e_CompareTypeAll and this can be one or a combination of these values. |
pdf::PDFDoc foxit::addon::comparison::Comparison::GenerateComparedDoc | ( | foxit::uint32 | compare_flags, |
bool | is_show_all_layers | ||
) |
Compare the base document with the compared document (which are used to construct current object) and then generate a PDF document as the comparison result.
Comparing the contents of two PDF documents and generating a new PDF document can take a long time.
[in] | compare_flags | Compare type which specifies what to be compared in PDF pages. Please refer to values starting from Comparison::e_CompareTypeAll and this can be one or a combination of these values. |
[in] | is_show_all_layers | A boolean value used to decide whether to show all comparison result layers or not. true means that all comparison result layers are shown by default, while false means only "Text" and "Images" comparison result layers are shown by default. |
bool foxit::addon::comparison::Comparison::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::addon::comparison::Comparison::operator!= | ( | const Comparison & | other | ) | const |
Not equal operator.
[in] | other | Another comparison object. This function will check if current object is not equal to this one. |
Comparison& foxit::addon::comparison::Comparison::operator= | ( | const Comparison & | other | ) |
Assign operator.
[in] | other | Another comparison object, whose value would be assigned to current object. |
bool foxit::addon::comparison::Comparison::operator== | ( | const Comparison & | other | ) | const |
Equal operator.
[in] | other | Another comparison object. This function will check if current object is equal to this one. |