All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
pdftron::PDF::HandwritingICROptions Class Reference

#include <HandwritingICROptions.h>

+ Inheritance diagram for pdftron::PDF::HandwritingICROptions:

Public Member Functions

 HandwritingICROptions ()
 
 ~HandwritingICROptions ()
 
HandwritingICROptions & AddIgnoreZonesForPage (const RectCollection &value, int page_num)
 
HandwritingICROptions & AddInclusionZonesForPage (const RectCollection &value, int page_num)
 
UString GetPages ()
 
HandwritingICROptions & SetPages (const UString &value)
 
- Public Member Functions inherited from pdftron::PDF::OptionsBase
 OptionsBase ()
 
 OptionsBase (const UString &json)
 

Additional Inherited Members

- Static Public Member Functions inherited from pdftron::PDF::OptionsBase
static SDF::Obj GetArray (SDF::Obj dict, const char *key)
 
static void PutNumber (SDF::Obj dict, const char *key, double num)
 
static void PutBool (SDF::Obj dict, const char *key, bool val)
 
static void PutText (SDF::Obj dict, const char *key, const UString &text)
 
static void PutRect (SDF::Obj dict, const char *key, const Rect &rect)
 
static void PushBackNumber (SDF::Obj dict, const char *key, double num)
 
static void PushBackBool (SDF::Obj dict, const char *key, bool val)
 
static void PushBackText (SDF::Obj dict, const char *key, const UString &text)
 
static void PushBackRect (SDF::Obj dict, const char *key, const Rect &rect)
 
static Rect RectFromArray (SDF::Obj nums)
 
static void InsertRectCollection (SDF::Obj dict, const char *key, const RectCollection &rects, int index)
 
static Rect RectFromArray (void *)
 
static double ColorPtToNumber (const ColorPt &cp)
 
static ColorPt ColorPtFromNumber (double dnum)
 

Detailed Description

Definition at line 9 of file HandwritingICROptions.h.

Constructor & Destructor Documentation

pdftron::PDF::HandwritingICROptions::HandwritingICROptions ( )
pdftron::PDF::HandwritingICROptions::~HandwritingICROptions ( )

Member Function Documentation

HandwritingICROptions& pdftron::PDF::HandwritingICROptions::AddIgnoreZonesForPage ( const RectCollection &  value,
int  page_num 
)

Adds the value to the IgnoreZonesForPage array. Optional list of page areas to be excluded from analysis. Zones should be provided as a collection of Rects paired with a page number. The Rects are then applied to the corresponding page. Rects are specified in User Space coordinates. If this is set, the specified areas will not be analyzed. If neither this nor InclusionZonesForPage is set, the entire page will be analyzed.

Parameters
valueList of page areas to be excluded from analysis.
page_numThe page number (1-indexed) to which the regions are applied.
Returns
This object, for call chaining.
HandwritingICROptions& pdftron::PDF::HandwritingICROptions::AddInclusionZonesForPage ( const RectCollection &  value,
int  page_num 
)

Adds the value to the InclusionZonesForPage array. Optional list of page areas to be included in analysis (to the exclusion of all other areas). Zones should be provided as a collection of Rects paired with a page number. The Rects are then applied to the corresponding page. Rects are specified in User Space coordinates. If this is set, only the areas specified will be analyzed. If neither this nor IgnoreZonesForPage is set, the entire page will be analyzed.

Parameters
valueList of page areas to be included in analysis.
page_numThe page number (1-indexed) to which the regions are applied.
Returns
This object, for call chaining.
UString pdftron::PDF::HandwritingICROptions::GetPages ( )

Gets the value Pages from the options object. Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.

Returns
The current value for Pages.
HandwritingICROptions& pdftron::PDF::HandwritingICROptions::SetPages ( const UString &  value)

Sets the value for Pages in the options object. Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.

Parameters
valueThe new value for Pages.
Returns
This object, for call chaining.
The documentation for this class was generated from the following file: