ScannerEntryOptions Class Reference

List of all members.

---

Detailed Description

Scanner image capture options.

The capture options string describes a multi-page dialog to capture one or more images within the host browser

Class ScannerEntryOptions represents the ScannerEntryOptions dtd as a PHP object

Public Member Functions
	addDialog ($aDialog)
	add a dialog page
	addMessage ($msg)
	Add a Message.
	addMessages ($msgs)
	Set a Message array.
	addScannerClass ($aClass)
	add a dialog page
	createBase64XML (&$strEncoding)
	Create the base64 encoded XML descriptor.
	createEncodedXML ($encoding)
	Create the base64 encoded XML descriptor.
	loadEncodedXML ($aXml, $encoding)
	Read a base64 encoded XML descriptor.
	ScannerEntryOptions ()
	Constructor.
Public Attributes
	$mResultEncoding = "Base64Zip"
	Result image encoding, String, "Base64Zip" "Base64Raw", "Base64ZipCompressed" or "Base64RawCompressed", optional.
	$mResultImage = "ImageNone"
	Result image format, String, use predefined constants eImageBmp, eImageTiff, eImageGif, eImagePng or eImageJpeg, optional.
	$mServiceAccess = FALSE
	web service object (ScannerService), optional
	$plDialog = array()
	Array of PlDialog objects, see addDialog.
	$plScannerClass = array()
	Array of PlScannerClass objects, see addScannerClass.
	$scanMsg = array()
	Array of scanner messages (ScannerMessage), call addMessage or addMessages, optional.
	$strXmlHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ScannerEntryOptions>\n</ScannerEntryOptions>"
Protected Member Functions
	createXML ()
	Create the XML descriptor.
	loadXML ($aXml)
	Read an XML descriptor.

---

Constructor & Destructor Documentation

ScannerEntryOptions.ScannerEntryOptions (   )

Constructor.

---

Member Function Documentation

ScannerEntryOptions.addDialog (  $  aDialog  )

add a dialog page Parameters: $aDialog  [i] ScannerDialog, the dialog to add

ScannerEntryOptions.addMessage (  $  msg  )

Add a Message. Parameters: $msg  [i] ScannerMessage, the message to add

ScannerEntryOptions.addMessages (  $  msgs  )

Set a Message array. Parameters: $msgs  [i] ScannerMessages, the message array to set Note: addMessages will clear all prior calls to addMessage

ScannerEntryOptions.addScannerClass (  $  aClass  )

add a dialog page Parameters: $aClass  [i] ScannerClass, the class to add

ScannerEntryOptions.createBase64XML (  &$  strEncoding  )

Create the base64 encoded XML descriptor.

ScannerEntryOptions.createEncodedXML (  $  encoding  )

Create the base64 encoded XML descriptor. Parameters: $encoding  [i] string, desired encoding, may be 'base64' or 'base64compressed' Returns: String, the encoded xml-string

ScannerEntryOptions.createXML (   )  [protected]

Create the XML descriptor.

ScannerEntryOptions.loadEncodedXML (  $  aXml, $  encoding )

Read a base64 encoded XML descriptor. Parameters: $aXml  [i] the xml description $encoding  [i] string, desired encoding, may be 'base64' or 'base64compressed'

ScannerEntryOptions.loadXML (  $  aXml  )  [protected]

Read an XML descriptor.

---

Member Data Documentation

ScannerEntryOptions.$mResultEncoding = "Base64Zip"

Result image encoding, String, "Base64Zip" "Base64Raw", "Base64ZipCompressed" or "Base64RawCompressed", optional.

ScannerEntryOptions.$mResultImage = "ImageNone"

Result image format, String, use predefined constants eImageBmp, eImageTiff, eImageGif, eImagePng or eImageJpeg, optional.

ScannerEntryOptions.$mServiceAccess = FALSE

web service object (ScannerService), optional

ScannerEntryOptions.$plDialog = array()

Array of PlDialog objects, see addDialog.

ScannerEntryOptions.$plScannerClass = array()

Array of PlScannerClass objects, see addScannerClass.

ScannerEntryOptions.$scanMsg = array()

Array of scanner messages (ScannerMessage), call addMessage or addMessages, optional.

ScannerEntryOptions.$strXmlHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ScannerEntryOptions>\n</ScannerEntryOptions>"

---

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

• signware_bapi.php