signware_bapi.php File Reference

---

Detailed Description

SignWare Dynamic Development toolkit.

Author:

uko

Access SignWare B-API from a PHP environment

This module accesses the SignWare b-api methods

Classes
class	CapPlugin
	Build a HTML string to instantiate the Browser plugin for the requested function. More...
class	PadEntryDialog
	Signature capture dialog. More...
class	PadEntryOptions
	Pad entry options, the root element of a pad entry descriptor. More...
class	PlAction
	Action object, an action is defined by an identifyer, an optional integer value and an optional string value. More...
class	PlButton
	Button element. More...
class	PlComboBox
	Combo box element. More...
class	PlComboItem
	Combo box items. More...
class	PlCoordinate
	Location and size coordinate for a visible element. More...
class	PlDocument
	Document element. More...
class	PlFont
	Font object, a font is defined by the font family, size and optional attributes. More...
class	PlIdleTimeout
	PlIdleTimeout object. More...
class	PlImage
	Image element. More...
class	PlRectangle
	Rectangle element. More...
class	PlSlider
	Slider element. More...
class	PlTablet
	Tablet object. More...
class	PlText
	Text element. More...
class	PlTextEntry
	Text entry element. More...
class	PluginParameters
	Helper class, plugin parameter container, an array of key equals value pairs. More...
class	ScannerClass
	Messages / Translations for Scanner capture and image cleaning module. More...
class	ScannerDialog
	A Scanner Dialog includes one or more ScannerWindow objects, optional ScannerSetting elements and optionally a few GUI elements (PlText and PlRectangle). More...
class	ScannerEntryOptions
	Scanner image capture options. More...
class	ScannerMessage
	Messages / Translations for Scanner capture and image cleaning module. More...
class	ScannerMessages
	Helper class that contains all messages in the Scanner capture plugin in english and german language. More...
class	ScannerSetting
	Container for one Scanner setting / parameter. More...
class	ScannerWindow
	Scanner Image capture options. More...
class	ServiceAccess
	ServiceAccess, info to access a web service. More...
Enumerations
enum	eCapabilityCanReacquire
	Scanner can acquire the image multiple times. More...
enum	eCapabilityCanUserGui
	Scanner driver supports user GUI and vendor GUI. More...
enum	eCapabilityHasDuplex
	Scanner has duplex feature. More...
enum	eImageBmp
	Image Format (ScannerEntryOptions.$mResultImage): Windows Bitmap, BMP. More...
enum	eImageGif
	Image Format(ScannerEntryOptions.$mResultImage): Graphics Interchange Format, GIF. More...
enum	eImageJpeg
	Image Format(ScannerEntryOptions.$mResultImage): Joint Photographic Experts Group, JPEG. More...
enum	eImagePng
	Image Format(ScannerEntryOptions.$mResultImage): Portable Network Graphics, PNG. More...
enum	eImageTiff
	Image Format(ScannerEntryOptions.$mResultImage): Tagged image file format, TIFF. More...
enum	ePapersizeA0
	ePropertyPapersize: A0 More...
enum	ePapersizeA1
	ePropertyPapersize: A1 More...
enum	ePapersizeA2
	ePropertyPapersize: A2 More...
enum	ePapersizeA3
	ePropertyPapersize: A3 More...
enum	ePapersizeA4
	ePropertyPapersize: A4 More...
enum	ePapersizeA5
	ePropertyPapersize: A5 More...
enum	ePapersizeA6
	ePropertyPapersize: A6 More...
enum	ePapersizeA7
	ePropertyPapersize: A7 More...
enum	ePapersizeA8
	ePropertyPapersize: A8 More...
enum	ePapersizeB2
	ePropertyPapersize: B2 More...
enum	ePapersizeB3
	ePropertyPapersize: B3 More...
enum	ePapersizeB4
	ePropertyPapersize: B4 More...
enum	ePapersizeB5
	ePropertyPapersize: B5 More...
enum	ePapersizeB6
	ePropertyPapersize: B6 More...
enum	ePapersizeC3
	ePropertyPapersize: C3 More...
enum	ePapersizeC4
	ePropertyPapersize: C4 More...
enum	ePapersizeC5
	ePropertyPapersize: C5 More...
enum	ePapersizeC6
	ePropertyPapersize: C6 More...
enum	ePapersizeCustom
	ePropertyPapersize: custom More...
enum	ePropertyBitsPerPixel
	Bit depth of the scan, 1, 8, 32. More...
enum	ePropertyBrightness
	Brightness of the scan. More...
enum	ePropertyCaptureAsynchronous
	Asynchronous vs Synchronous capture mode. More...
enum	ePropertyContrast
	Contrast of the scan. More...
enum	ePropertyDeviceDescription
	Device description. More...
enum	ePropertyDeviceId
	Device identifyer. More...
enum	ePropertyDeviceName
	Device name. More...
enum	ePropertyDeviceType
	Device type. More...
enum	ePropertyDriverClassName
	Driver class name. More...
enum	ePropertyDriverName
	Driver name. More...
enum	ePropertyFirmwareVersion
	Firmware version of the driver. More...
enum	ePropertyForceImageSize
	Scanner DirectShow: resize the captured image if the size exceeds the spicified width or height. More...
enum	ePropertyHeight
	Height of the scan. More...
enum	ePropertyImageFormat
	Image fformat of the scan. More...
enum	ePropertyLightSource
	Lightsource of the scan. More...
enum	ePropertyOffsetX
	Left offset of the scan. More...
enum	ePropertyOffsetY
	Top offset of the scan. More...
enum	ePropertyPapersize
	Property Papersize. More...
enum	ePropertyResolutionX
	Horicontal resolution of the scan. More...
enum	ePropertyResolutionY
	Vertical resolution of the scan. More...
enum	ePropertyThreshold
	Binarization threshold of the scan, only for black-white scans. More...
enum	ePropertyThumbHeight
	Thumbnail height. More...
enum	ePropertyThumbWidth
	Thumbnail width. More...
enum	ePropertyVendorName
	Vendor name. More...
enum	ePropertyWidth
	Width of the scan. More...
enum	IMAGE_WINDOW
	Scanner window class: Scanner image display window. More...
enum	PL_ACTION_CANCEL
	Action identifyer, Action Cancel. More...
enum	PL_ACTION_ERASE
	Action identifyer, Action Erase. More...
enum	PL_ACTION_FILE_OPEN
	Action identifyer, Action popup a file open selector. More...
enum	PL_ACTION_FORMFIELD
	Action identifyer, PlTextEntry, PlSlider or PlCombobox may be formfields. More...
enum	PL_ACTION_GOPAGE
	Action identifyer, Action goto page. More...
enum	PL_ACTION_IMAGE_CLEANLINES
	Action identifyer, Action clean lines (in an image). More...
enum	PL_ACTION_IMAGE_CLEANRECT
	Action identifyer, Action clean frames (of an image). More...
enum	PL_ACTION_IMAGE_CLEANWEIGHT
	Action identifyer, Action set the cleaning weight. More...
enum	PL_ACTION_IMAGE_CROP
	Action identifyer, Action crop (image). More...
enum	PL_ACTION_IMAGE_EDIT
	Action identifyer, Action set edit state active. More...
enum	PL_ACTION_IMAGE_INVERT
	Action identifyer, Action invert (image). More...
enum	PL_ACTION_IMAGE_MIRROR
	Action identifyer, Action mirror (image). More...
enum	PL_ACTION_IMAGE_PENSIZE
	Action identifyer, Action set a pen size. More...
enum	PL_ACTION_IMAGE_ROTATE
	Action identifyer, Action rotate (image). More...
enum	PL_ACTION_IMAGE_UNDO
	Action identifyer, Action undo last operation. More...
enum	PL_ACTION_IMAGE_WHITENER
	Action identifyer, Action clean background (of an image). More...
enum	PL_ACTION_IMAGE_ZOOM
	Action identifyer, Action zoom. More...
enum	PL_ACTION_NEXT
	Action identifyer, Action Next (page). More...
enum	PL_ACTION_OK
	Action identifyer, Action OK. More...
enum	PL_ACTION_PREV
	Action identifyer, Action Previous (page). More...
enum	PL_ACTION_SCAN_IMAGE
	Action identifyer, Action scan an image. More...
enum	PL_ACTION_SCAN_SETTINGS
	Action identifyer, Action display scanner settings dialog. More...
enum	PL_ACTION_SCANNER_BITDEPTH
	Action identifyer, Action set (scanner) bit depth. More...
enum	PL_ACTION_SCANNER_BRIGHTNESS
	Action identifyer, Action set (scanner) brightness. More...
enum	PL_ACTION_SCANNER_CONTRAST
	Action identifyer, Action set (scanner) contrast. More...
enum	PL_ACTION_SCANNER_HEIGHT
	Action identifyer, Action set (scanner) height [mm]. More...
enum	PL_ACTION_SCANNER_LEFT
	Action identifyer, Action set (scanner) left position [mm]. More...
enum	PL_ACTION_SCANNER_LIGHTSOURCE
	Action identifyer, Action set (scanner) lightsource. More...
enum	PL_ACTION_SCANNER_PAPERSIZE
	Action identifyer, Action set paper size. More...
enum	PL_ACTION_SCANNER_RESOLUTION
	Action identifyer, Action set (scanner) resolution. More...
enum	PL_ACTION_SCANNER_SELECT
	Action identifyer, Action select scanner source. More...
enum	PL_ACTION_SCANNER_THRESHOLD
	Action identifyer, Action set (BW) threshold. More...
enum	PL_ACTION_SCANNER_TOP
	Action identifyer, Action set (scanner) top positions [mm]. More...
enum	PL_ACTION_SCANNER_WIDTH
	Action identifyer, Action set (scanner) width [mm]. More...
enum	PL_ACTION_SENDTO
	Action identifyer, Action SendTo. More...
enum	PL_ACTION_SIGN_DOCUMENT
	Action identifyer, Action sign a document. More...
enum	PL_ACTION_TOGGLE
	Action identifyer, Action Toggle (Button value). More...
enum	PL_BUTTON_MOUSE
	The object is clickable with the mouse. More...
enum	PL_BUTTON_PEN
	The object is clickable with the pad pen. More...
enum	PL_CLIP_SCREEN
	Tablet attribute: clip signature entry on screen (and in final signature) (PlTablet.$mFlags). More...
enum	PL_CLIP_TABLET
	Tablet attribute: clip signature entry on tablet (PlTablet.$mFlags). More...
enum	PL_COORDINATE_DOCUMENT
	PlCoordinate Origin: origin is the document. More...
enum	PL_COORDINATE_ENTRY
	PlCoordinate Origin: origin is the pad-entry or scanner window. More...
enum	PL_COORDINATE_PLUGIN
	PlCoordinate Origin: origin is the plugin window. More...
enum	PL_DRAWFLAGS_DRAWWND
	draw an object in the entry window as a virtual element More...
enum	PL_DRAWFLAGS_IMAGE
	draw an object as imagee in the entry window as a virtual element More...
enum	PL_DRAWFLAGS_LCD
	draw an object on the tablet LCD screen as a virtual element More...
enum	PL_DRAWFLAGS_OPAQUE
	Draw an image with a transparent color. More...
enum	PL_DRAWFLAGS_PLUGINWND
	draw an object in the plugin window as a native window More...
enum	PL_FONT_BOLD
	Font attribute bold (PlFont.$mFlags). More...
enum	PL_FONT_ITALIC
	Font attribute italic (PlFont.$mFlags). More...
enum	PL_FONT_STRIKEOUT
	Font attribute strikeout (PlFont.$mFlags). More...
enum	PL_FONT_UNDERLINE
	Font attribute underline (PlFont.$mFlags). More...
enum	PL_FORCE_BW
	Tablet attribute: force a b/w image (PlTablet.$mFlags). More...
enum	PL_IMAGE_BASE64_BMP
	Imagedata is a base64 encoded windows bitmaap. More...
enum	PL_IMAGE_BASE64_COMPRESSED_BMP
	Imagedata is a base64 encoded and zlib compressed windows bitmaap. More...
enum	PL_IMAGE_EMPTY
	Create an empty image. More...
enum	PL_IMAGE_LOCAL_FILE
	Read the image from the local filesystem, imagedata is the path to the image. More...
enum	PL_SLIDER_HORIZONTAL
	Orientate the slider horizontal, else the slider will be oriented vertical. More...
enum	PL_TABLET_MIRROR
	Tablet attribute: mirror the image and vectors horizontally (PlTablet.$mFlags). More...
enum	PL_TABLET_NOECHO
	Tablet attribute: don't display strokes (PlTablet.$mFlags). More...
enum	PL_TEXTFLAGS_BOTTOM
	Align the text to the bottom of the text field. More...
enum	PL_TEXTFLAGS_EXPANDTABS
	Expand tab's. More...
enum	PL_TEXTFLAGS_HCENTER
	Center the text horizontally in the text field. More...
enum	PL_TEXTFLAGS_LEFT
	Align the text to the left of the text field. More...
enum	PL_TEXTFLAGS_RIGHT
	Align the text to the right of the text field. More...
enum	PL_TEXTFLAGS_SINGLELINE
	Single line text field. More...
enum	PL_TEXTFLAGS_TOP
	Align the text to the top of the text field. More...
enum	PL_TEXTFLAGS_VCENTER
	Center the text vertically in the text field. More...
enum	PL_TEXTFLAGS_WORDBREAK
	Break words in a multiline text field. More...
enum	SCANNER_CAPTURE_DIALOG
	Scanner dialog class: Scanner capture dialog. More...
enum	SCANNER_SELECTSOURCE_DIALOG
	Scanner dialog class: Select scanner source settings dialog. More...
enum	SCANNER_SETTINGS_DIALOG
	Scanner dialog class: Scanner settings dialog. More...
enum	TOOL_WINDOW
	Scanner window class: Scanner tools window. More...
enum	VIDEO_WINDOW
	Scanner window class: Scanner (live) video window. More...
Functions
	addAttributeInt ($xml, $name, $value)
	local helper function to append an integer attribute to a SimpleXMLElement
	addAttributeIntOpt ($xml, $name, $value)
	local helper function to append an optional integer attribute to a SimpleXMLElement
	addAttributeStr ($xml, $name, $value)
	local helper function to append a string attribute to a SimpleXMLElement
	addAttributeStrOpt ($xml, $name, $value)
	local helper function to append an optional string attribute to a SimpleXMLElement
	strToBool ($str)
	strToInt ($str)

---

Enumeration Type Documentation

enum eCapabilityCanReacquire

Scanner can acquire the image multiple times.

enum eCapabilityCanUserGui

Scanner driver supports user GUI and vendor GUI.

enum eCapabilityHasDuplex

Scanner has duplex feature.

enum eImageBmp

Image Format (ScannerEntryOptions.$mResultImage): Windows Bitmap, BMP.

enum eImageGif

Image Format(ScannerEntryOptions.$mResultImage): Graphics Interchange Format, GIF.

enum eImageJpeg

Image Format(ScannerEntryOptions.$mResultImage): Joint Photographic Experts Group, JPEG.

enum eImagePng

Image Format(ScannerEntryOptions.$mResultImage): Portable Network Graphics, PNG.

enum eImageTiff

Image Format(ScannerEntryOptions.$mResultImage): Tagged image file format, TIFF.

enum ePapersizeA0

ePropertyPapersize: A0

enum ePapersizeA1

ePropertyPapersize: A1

enum ePapersizeA2

ePropertyPapersize: A2

enum ePapersizeA3

ePropertyPapersize: A3

enum ePapersizeA4

ePropertyPapersize: A4

enum ePapersizeA5

ePropertyPapersize: A5

enum ePapersizeA6

ePropertyPapersize: A6

enum ePapersizeA7

ePropertyPapersize: A7

enum ePapersizeA8

ePropertyPapersize: A8

enum ePapersizeB2

ePropertyPapersize: B2

enum ePapersizeB3

ePropertyPapersize: B3

enum ePapersizeB4

ePropertyPapersize: B4

enum ePapersizeB5

ePropertyPapersize: B5

enum ePapersizeB6

ePropertyPapersize: B6

enum ePapersizeC3

ePropertyPapersize: C3

enum ePapersizeC4

ePropertyPapersize: C4

enum ePapersizeC5

ePropertyPapersize: C5

enum ePapersizeC6

ePropertyPapersize: C6

enum ePapersizeCustom

ePropertyPapersize: custom

enum ePropertyBitsPerPixel

Bit depth of the scan, 1, 8, 32.

enum ePropertyBrightness

Brightness of the scan.

enum ePropertyCaptureAsynchronous

Asynchronous vs Synchronous capture mode.

enum ePropertyContrast

Contrast of the scan.

enum ePropertyDeviceDescription

Device description.

enum ePropertyDeviceId

Device identifyer.

enum ePropertyDeviceName

Device name.

enum ePropertyDeviceType

Device type.

enum ePropertyDriverClassName

Driver class name.

enum ePropertyDriverName

Driver name.

enum ePropertyFirmwareVersion

Firmware version of the driver.

enum ePropertyForceImageSize

Scanner DirectShow: resize the captured image if the size exceeds the spicified width or height.

enum ePropertyHeight

Height of the scan.

enum ePropertyImageFormat

Image fformat of the scan.

enum ePropertyLightSource

Lightsource of the scan.

enum ePropertyOffsetX

Left offset of the scan.

enum ePropertyOffsetY

Top offset of the scan.

enum ePropertyPapersize

Property Papersize. set the papersize to one of the predefined constants. Note: ePaperSizeCustom requires ePropertyWidth, ePropertyHeight, ePropertyOffsetX and ePropertyOffsetY. The Papersizes are defined as numeric values ComboBoxItems require numeric values, the numeric values allow for selecting paper size in a combo box. Use the string parameter for the combo box item to display the human readable paper size equivalent

enum ePropertyResolutionX

Horicontal resolution of the scan.

enum ePropertyResolutionY

Vertical resolution of the scan.

enum ePropertyThreshold

Binarization threshold of the scan, only for black-white scans.

enum ePropertyThumbHeight

Thumbnail height.

enum ePropertyThumbWidth

Thumbnail width.

enum ePropertyVendorName

Vendor name.

enum ePropertyWidth

Width of the scan.

enum IMAGE_WINDOW

Scanner window class: Scanner image display window.

enum PL_ACTION_CANCEL

Action identifyer, Action Cancel.

enum PL_ACTION_ERASE

Action identifyer, Action Erase.

enum PL_ACTION_FILE_OPEN

Action identifyer, Action popup a file open selector.

enum PL_ACTION_FORMFIELD

Action identifyer, PlTextEntry, PlSlider or PlCombobox may be formfields.

enum PL_ACTION_GOPAGE

Action identifyer, Action goto page.

enum PL_ACTION_IMAGE_CLEANLINES

Action identifyer, Action clean lines (in an image).

enum PL_ACTION_IMAGE_CLEANRECT

Action identifyer, Action clean frames (of an image).

enum PL_ACTION_IMAGE_CLEANWEIGHT

Action identifyer, Action set the cleaning weight.

enum PL_ACTION_IMAGE_CROP

Action identifyer, Action crop (image).

enum PL_ACTION_IMAGE_EDIT

Action identifyer, Action set edit state active.

enum PL_ACTION_IMAGE_INVERT

Action identifyer, Action invert (image).

enum PL_ACTION_IMAGE_MIRROR

Action identifyer, Action mirror (image).

enum PL_ACTION_IMAGE_PENSIZE

Action identifyer, Action set a pen size.

enum PL_ACTION_IMAGE_ROTATE

Action identifyer, Action rotate (image).

enum PL_ACTION_IMAGE_UNDO

Action identifyer, Action undo last operation.

enum PL_ACTION_IMAGE_WHITENER

Action identifyer, Action clean background (of an image).

enum PL_ACTION_IMAGE_ZOOM

Action identifyer, Action zoom.

enum PL_ACTION_NEXT

Action identifyer, Action Next (page).

enum PL_ACTION_OK

Action identifyer, Action OK.

enum PL_ACTION_PREV

Action identifyer, Action Previous (page).

enum PL_ACTION_SCAN_IMAGE

Action identifyer, Action scan an image.

enum PL_ACTION_SCAN_SETTINGS

Action identifyer, Action display scanner settings dialog.

enum PL_ACTION_SCANNER_BITDEPTH

Action identifyer, Action set (scanner) bit depth.

enum PL_ACTION_SCANNER_BRIGHTNESS

Action identifyer, Action set (scanner) brightness.

enum PL_ACTION_SCANNER_CONTRAST

Action identifyer, Action set (scanner) contrast.

enum PL_ACTION_SCANNER_HEIGHT

Action identifyer, Action set (scanner) height [mm].

enum PL_ACTION_SCANNER_LEFT

Action identifyer, Action set (scanner) left position [mm].

enum PL_ACTION_SCANNER_LIGHTSOURCE

Action identifyer, Action set (scanner) lightsource.

enum PL_ACTION_SCANNER_PAPERSIZE

Action identifyer, Action set paper size.

enum PL_ACTION_SCANNER_RESOLUTION

Action identifyer, Action set (scanner) resolution.

enum PL_ACTION_SCANNER_SELECT

Action identifyer, Action select scanner source.

enum PL_ACTION_SCANNER_THRESHOLD

Action identifyer, Action set (BW) threshold.

enum PL_ACTION_SCANNER_TOP

Action identifyer, Action set (scanner) top positions [mm].

enum PL_ACTION_SCANNER_WIDTH

Action identifyer, Action set (scanner) width [mm].

enum PL_ACTION_SENDTO

Action identifyer, Action SendTo.

enum PL_ACTION_SIGN_DOCUMENT

Action identifyer, Action sign a document.

enum PL_ACTION_TOGGLE

Action identifyer, Action Toggle (Button value).

enum PL_BUTTON_MOUSE

The object is clickable with the mouse.

enum PL_BUTTON_PEN

The object is clickable with the pad pen.

enum PL_CLIP_SCREEN

Tablet attribute: clip signature entry on screen (and in final signature) (PlTablet.$mFlags).

enum PL_CLIP_TABLET

Tablet attribute: clip signature entry on tablet (PlTablet.$mFlags).

enum PL_COORDINATE_DOCUMENT

PlCoordinate Origin: origin is the document.

enum PL_COORDINATE_ENTRY

PlCoordinate Origin: origin is the pad-entry or scanner window.

enum PL_COORDINATE_PLUGIN

PlCoordinate Origin: origin is the plugin window.

enum PL_DRAWFLAGS_DRAWWND

draw an object in the entry window as a virtual element

enum PL_DRAWFLAGS_IMAGE

draw an object as imagee in the entry window as a virtual element Note: This flag is typically used for debugging purposes

enum PL_DRAWFLAGS_LCD

draw an object on the tablet LCD screen as a virtual element

enum PL_DRAWFLAGS_OPAQUE

Draw an image with a transparent color. Note: Please also set PlImage.mTransparentColor

enum PL_DRAWFLAGS_PLUGINWND

draw an object in the plugin window as a native window

enum PL_FONT_BOLD

Font attribute bold (PlFont.$mFlags).

enum PL_FONT_ITALIC

Font attribute italic (PlFont.$mFlags).

enum PL_FONT_STRIKEOUT

Font attribute strikeout (PlFont.$mFlags).

enum PL_FONT_UNDERLINE

Font attribute underline (PlFont.$mFlags).

enum PL_FORCE_BW

Tablet attribute: force a b/w image (PlTablet.$mFlags).

enum PL_IMAGE_BASE64_BMP

Imagedata is a base64 encoded windows bitmaap.

enum PL_IMAGE_BASE64_COMPRESSED_BMP

Imagedata is a base64 encoded and zlib compressed windows bitmaap.

enum PL_IMAGE_EMPTY

Create an empty image.

enum PL_IMAGE_LOCAL_FILE

Read the image from the local filesystem, imagedata is the path to the image.

enum PL_SLIDER_HORIZONTAL

Orientate the slider horizontal, else the slider will be oriented vertical.

enum PL_TABLET_MIRROR

Tablet attribute: mirror the image and vectors horizontally (PlTablet.$mFlags).

enum PL_TABLET_NOECHO

Tablet attribute: don't display strokes (PlTablet.$mFlags).

enum PL_TEXTFLAGS_BOTTOM

Align the text to the bottom of the text field.

enum PL_TEXTFLAGS_EXPANDTABS

Expand tab's.

enum PL_TEXTFLAGS_HCENTER

Center the text horizontally in the text field.

enum PL_TEXTFLAGS_LEFT

Align the text to the left of the text field.

enum PL_TEXTFLAGS_RIGHT

Align the text to the right of the text field.

enum PL_TEXTFLAGS_SINGLELINE

Single line text field.

enum PL_TEXTFLAGS_TOP

Align the text to the top of the text field.

enum PL_TEXTFLAGS_VCENTER

Center the text vertically in the text field.

enum PL_TEXTFLAGS_WORDBREAK

Break words in a multiline text field.

enum SCANNER_CAPTURE_DIALOG

Scanner dialog class: Scanner capture dialog.

enum SCANNER_SELECTSOURCE_DIALOG

Scanner dialog class: Select scanner source settings dialog.

enum SCANNER_SETTINGS_DIALOG

Scanner dialog class: Scanner settings dialog.

enum TOOL_WINDOW

Scanner window class: Scanner tools window.

enum VIDEO_WINDOW

Scanner window class: Scanner (live) video window.

---

Function Documentation

addAttributeInt (  $  xml, $  name, $  value )

local helper function to append an integer attribute to a SimpleXMLElement Parameters: $xml  [io] the SimpleXMLElement $name  [i] the attribute name $value  [i] the attribute value Exceptions: Exception  if $value does not evaluate to a number

addAttributeIntOpt (  $  xml, $  name, $  value )

local helper function to append an optional integer attribute to a SimpleXMLElement Parameters: $xml  [io] the SimpleXMLElement $name  [i] the attribute name $value  [i] the attribute value Exceptions: Exception  if $value does not evaluate to a number

addAttributeStr (  $  xml, $  name, $  value )

local helper function to append a string attribute to a SimpleXMLElement Parameters: $xml  [io] the SimpleXMLElement $name  [i] the attribute name $value  [i] the attribute value, must be set (at least "")

addAttributeStrOpt (  $  xml, $  name, $  value )

local helper function to append an optional string attribute to a SimpleXMLElement Parameters: $xml  [io] the SimpleXMLElement $name  [i] the attribute name $value  [i] the attribute value, may be null

strToBool (  $  str  )

Convert a string to an bool The string may be true | false | number

strToInt (  $  str  )

Convert a string to an int The string may be prepended with 0x to indicate a hex string