visit Kofax web site

ScannerDialog Class Reference

List of all members.

Detailed Description

A Scanner Dialog includes one or more ScannerWindow objects, optional ScannerSetting elements and optionally a few GUI elements (PlText and PlRectangle).

Class ScannerDialog represents the ScannerDialog dtd as a PHP object, a Dialog contains one or more ScannerWindow objects


Public Member Functions

 addRectangle ($pR)
 Add Rectangle to this dialog.
 addSetting ($aSet)
 Add a scanner setting / parameter element to this dialog.
 addText ($pT)
 Add text to this dialog.
 addWindow ($aWnd)
 Add a ScannerWindow to this dialog.
 readXML (&$xml)
 Read an XML descriptor.
 ScannerDialog ($aClass=SCANNER_CAPTURE_DIALOG)
 Constructor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mAllowCrop = 'left'
 Allow cropping a region in the captured image, default: 'left' valid Values: 'left' (compatibility: TRUE), 'none' (compatibility: FALSE), 'right'.
 $mBgColor = FALSE
 Background color, integer, optional.
 $mClass = SCANNER_CAPTURE_DIALOG
 Class name, SCANNER_CAPTURE_DIALOG or SCANNER_SETTINGS_DIALOG.
 $mFgColor = FALSE
 Foreground color, integer, optional.
 $plCoordinate
 PlCoordinate object, required.
 $plRectangle = 0
 Array of optional PlRectangle objects, see addRectangle.
 $plSettings = FALSE
 Array of optional PlSetting objects, see addSetting.
 $plText = 0
 Array of optional PlText objects, see addText.
 $plWindows = FALSE
 Array of optional PlWindow objects, see addWindow.


Constructor & Destructor Documentation

ScannerDialog.ScannerDialog aClass = SCANNER_CAPTURE_DIALOG  ) 
 

Constructor.

Parameters:
$aClass [i], String, the class name of this dialog, use predefined constants SCANNER_CAPTURE_DIALOG or SCANNER_SETTINGS_DIALOG


Member Function Documentation

ScannerDialog.addRectangle pR  ) 
 

Add Rectangle to this dialog.

Parameters:
$pR [i] PlRectangle, the rectangle to add

ScannerDialog.addSetting aSet  ) 
 

Add a scanner setting / parameter element to this dialog.

Parameters:
$aSet [i] ScannerSetting, the setting to add

ScannerDialog.addText pT  ) 
 

Add text to this dialog.

Parameters:
$pT [i] PlText, the text to add

ScannerDialog.addWindow aWnd  ) 
 

Add a ScannerWindow to this dialog.

Parameters:
$aWnd [i] ScannerWindow, the window to add

ScannerDialog.readXML &$  xml  ) 
 

Read an XML descriptor.

ScannerDialog.writeXML &$  xml  ) 
 

Write the XML descriptor.


Member Data Documentation

ScannerDialog.$mAllowCrop = 'left'
 

Allow cropping a region in the captured image, default: 'left' valid Values: 'left' (compatibility: TRUE), 'none' (compatibility: FALSE), 'right'.

ScannerDialog.$mBgColor = FALSE
 

Background color, integer, optional.

ScannerDialog.$mClass = SCANNER_CAPTURE_DIALOG
 

Class name, SCANNER_CAPTURE_DIALOG or SCANNER_SETTINGS_DIALOG.

ScannerDialog.$mFgColor = FALSE
 

Foreground color, integer, optional.

ScannerDialog.$plCoordinate
 

PlCoordinate object, required.

ScannerDialog.$plRectangle = 0
 

Array of optional PlRectangle objects, see addRectangle.

ScannerDialog.$plSettings = FALSE
 

Array of optional PlSetting objects, see addSetting.

ScannerDialog.$plText = 0
 

Array of optional PlText objects, see addText.

ScannerDialog.$plWindows = FALSE
 

Array of optional PlWindow objects, see addWindow.


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