Analyze the layout of a FixedPage, grouping together text deemed to be in horizontal and/or vertical blocks. Useful for text search and selection.
More...
#include <text.h>
|
|
virtual IDOMFixedPagePtr | getFixedPage () const =0 |
| | Get the FixedPage being processed.
|
| |
|
virtual void | analyze (ePageAnalysis analysisToPerform=ePAAll)=0 |
| | Process the page find the blocks of text. Can optionally perform each analysis phase independently (which can be useful when debugging).
|
| |
|
virtual String | getLayoutInfo () const =0 |
| | Get a textual description of the page content, useful for debugging purposes.
|
| |
|
virtual IPageLayoutDataPtr | getLayoutData () const =0 |
| | Get a processed representation of the page content.
|
| |
|
virtual IPageLayoutNodeCollection | getLayoutNodeCollection () const =0 |
| | Get a flat collection of page content nodes.
|
| |
|
virtual String | getPageText () const =0 |
| | Return all page text.
|
| |
| virtual void | setVirtualSpaceThreshold (double virtualSpaceThreshold)=0 |
| | Set the virtual space threshold.
|
| |
| virtual void | setMultipleSpaceMode (bool multipleSpaces)=0 |
| | Set the multiple space mode for inserting virtual spaces.
|
| |
| virtual void | setLineSpacingThreshold (double threshold)=0 |
| | Set the threshold for spacing between successive text lines when concatenating them into a text run.
|
| |
|
virtual void | addRef () const =0 |
| | Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
|
| |
| virtual bool | decRef () const =0 |
| | Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
|
| |
| virtual int32 | getRefCount () const =0 |
| | Retrieve the current reference count of the actual object pointed to.
|
| |
|
|
virtual | ~IRCObject () |
| | Virtual destructor.
|
| |
Analyze the layout of a FixedPage, grouping together text deemed to be in horizontal and/or vertical blocks. Useful for text search and selection.
◆ create() [1/2]
| static JAWSMAKO_API IPageLayoutPtr JawsMako::IPageLayout::create |
( |
IEDLClassFactory * | factory, |
|
|
const CTextRunVect & | runs ) |
|
static |
Creation function for an IPageLayout, a fixed page layout analyser Throws an IEDLError on failure.
- Parameters
-
| factory | The factory to use |
| runs | The arrary of text runs to be analysed |
- Returns
- IPageLayoutPtr The new page layout analyser
◆ create() [2/2]
| static JAWSMAKO_API IPageLayoutPtr JawsMako::IPageLayout::create |
( |
IEDLClassFactory * | factory, |
|
|
const IDOMFixedPagePtr & | page ) |
|
static |
Creation function for an IPageLayout, a fixed page layout analyser Throws an IEDLError on failure.
- Parameters
-
| factory | The factory to use. |
| page | The fixed page to be analysed |
- Returns
- IPageLayoutPtr The new page layout analyser
◆ setLineSpacingThreshold()
| virtual void JawsMako::IPageLayout::setLineSpacingThreshold |
( |
double | threshold | ) |
|
|
pure virtual |
Set the threshold for spacing between successive text lines when concatenating them into a text run.
- Parameters
-
| threshold | The distance expressed in 1/96th inch between the bottom edge of a given line of text and the top edge of the text line immediately below it. The value may be negative to allow text lines that are very closely spaced or even overlapping vertically to be recognized as separate lines. The default value is 0.0. |
◆ setMultipleSpaceMode()
| virtual void JawsMako::IPageLayout::setMultipleSpaceMode |
( |
bool | multipleSpaces | ) |
|
|
pure virtual |
Set the multiple space mode for inserting virtual spaces.
- Parameters
-
| multipleSpaces | The flag determining if inserting multiple virtual spaces or a single space. If true was specified, multiple virtual spaces would be inserted, If false was specified, a single space would be inserted to be compatible with Acrobat behaviour. The default is true. |
◆ setVirtualSpaceThreshold()
| virtual void JawsMako::IPageLayout::setVirtualSpaceThreshold |
( |
double | virtualSpaceThreshold | ) |
|
|
pure virtual |
Set the virtual space threshold.
- Parameters
-
| virtualSpaceThreshold | The threshold determining if inserting virtual spaces. The range of this value is limited between 0.0 ~ 1.0, and the default is 0.75. |
The documentation for this class was generated from the following file:
Public Member Functions inherited from IRCObject