visit Kofax web site

ScannerSetting Class Reference

List of all members.

Detailed Description

Container for one Scanner setting / parameter.

A Scanner parameter consists of a key equals value pair, and the optional flag if the parameter must be supported by the scanner.

Note:
The required flag is currently not evaluated


Public Member Functions

 readXML (&$xml)
 Read an XML descriptor.
 ScannerSetting ($aPropertyId, $aValue="", $requ=FALSE)
 Constructor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mPropertyId
 Property name, String, required.
 $mRequired
 Flag if the property must be set to value, boolean, unsupported.
 $mValue
 Property value, Mixed, required.


Constructor & Destructor Documentation

ScannerSetting.ScannerSetting aPropertyId,
aValue = "",
requ = FALSE
 

Constructor.

Parameters:
$aPropertyId [i] String, name of the Property, required
$aValue [i] Mixed, Value, required
$requ [i] boolean, Flag to determine if the property is required, optional


Member Function Documentation

ScannerSetting.readXML &$  xml  ) 
 

Read an XML descriptor.

ScannerSetting.writeXML &$  xml  ) 
 

Write the XML descriptor.


Member Data Documentation

ScannerSetting.$mPropertyId
 

Property name, String, required.

ScannerSetting.$mRequired
 

Flag if the property must be set to value, boolean, unsupported.

ScannerSetting.$mValue
 

Property value, Mixed, required.


The documentation for this class was generated from the following file: