Foxit PDF SDK
|
Public Member Functions | |
LRContext (const LRContext &other) | |
Constructor, with another context object. More... | |
LRContext (const pdf::PDFPage &page) | |
Constructor, from a PDF Page object. More... | |
~LRContext () | |
Destructor. | |
LRStructureElement | GetRootElement () |
Get the root element of structure tree. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const LRContext &other) const |
Not equal operator. More... | |
LRContext & | operator= (const LRContext &other) |
Assign operator. More... | |
bool | operator== (const LRContext &other) const |
Equal operator. More... | |
common::Progressive | StartParse (common::PauseCallback *pause=0) |
Start to parse layout recognition for related PDF page. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class can be used to parse layout recognition to get the root element.
foxit::addon::layoutrecognition::LRContext::LRContext | ( | const pdf::PDFPage & | page | ) |
Constructor, from a PDF Page object.
[in] | page | A valid PDF page object. |
foxit::addon::layoutrecognition::LRContext::LRContext | ( | const LRContext & | other | ) |
Constructor, with another context object.
[in] | other | Another context object. |
LRStructureElement foxit::addon::layoutrecognition::LRContext::GetRootElement | ( | ) |
Get the root element of structure tree.
Please ensure current context object has been parsed successfully before calling this function; otherwise, no valid root structure element can be retrieved.
bool foxit::addon::layoutrecognition::LRContext::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::layoutrecognition::LRContext::operator!= | ( | const LRContext & | other | ) | const |
Not equal operator.
[in] | other | Another context object. This function will check if current object is not equal to this one. |
Assign operator.
[in] | other | Another context object, whose value would be assigned to current object. |
bool foxit::addon::layoutrecognition::LRContext::operator== | ( | const LRContext & | other | ) | const |
Equal operator.
[in] | other | Another context object. This function will check if current object is equal to this one. |
common::Progressive foxit::addon::layoutrecognition::LRContext::StartParse | ( | common::PauseCallback * | pause = 0 | ) |
Start to parse layout recognition for related PDF page.
It may take a long time to do parsing, so Foxit PDF SDK uses a progressive process to do this. If there is any error occurs in parsing progress, this function will throw exception. Please refer to class foxit::Exception and values starting from foxit::e_ErrFile.
[in] | pause | Pause callback object which decides if the parsing process needs to be paused. This can be NULL which means not to pause during the parsing process. If this is not NULL, it should be a valid pause object implemented by user. Default value: NULL. |