PlDocument Class Reference

List of all members.

---

Detailed Description

Document element.

Class PlDocument represents the element PlDocument in PadEntryOptions-dtd as a PHP object

Public Member Functions
	addButton ($aButton)
	Add a Button.
	addSlider ($aSlider)
	Add a Slider.
	loadImageFile ($aName)
	Load an image file on the server.
	PlDocument ()
	Constructor.
	readXML (&$xml)
	Read an XML descriptor.
	writeXML (&$xml)
	Write the XML descriptor.
Public Attributes
	$mDocument = FALSE
	Document data, use loadImageFile to pass a bitmap from the server.
	$mDrawflags = 0
	Flag to specify whether to draw the text in the browser window and / or on the tablet LCD.Combination of: PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen PL_DRAWFLAGS_LCD, draw the button on the tablet LCD PL_DRAWFLAGS_OPAQUE, draw the image opaque
	$mFormat = 0
	Format specifyer, either one: PL_IMAGE_LOCAL_FILE PL_IMAGE_BASE64_BMP PL_IMAGE_BASE64_COMPRESSED_BMP PL_IMAGE_EMPTY, $width and height must be passed
	$mTransparentColor = -1
	$mZoom = FALSE
	$plCoordinate = FALSE
	Coordinate object (PlCoordinate), required.
	$vPlButton = FALSE
	array of buttons, optional
	$vPlSlider = FALSE
	array of sliders, optional

---

Constructor & Destructor Documentation

PlDocument.PlDocument (   )

Constructor.

---

Member Function Documentation

PlDocument.addButton (  $  aButton  )

Add a Button. Parameters: $aButton  [i] the button object to add

PlDocument.addSlider (  $  aSlider  )

Add a Slider. Parameters: $aSlider  [i] the slider object to add

PlDocument.loadImageFile (  $  aName  )

Load an image file on the server. Parameters: $aName  relative image path on the server Exceptions: Exception  on errors such as file not found Note: loadImageFile sets $image and $format The image must be in Windows Bitmap format

PlDocument.readXML (  &$  xml  )

Read an XML descriptor.

PlDocument.writeXML (  &$  xml  )

Write the XML descriptor.

---

Member Data Documentation

PlDocument.$mDocument = FALSE

Document data, use loadImageFile to pass a bitmap from the server.

PlDocument.$mDrawflags = 0

Flag to specify whether to draw the text in the browser window and / or on the tablet LCD.Combination of: PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen PL_DRAWFLAGS_LCD, draw the button on the tablet LCD PL_DRAWFLAGS_OPAQUE, draw the image opaque

PlDocument.$mFormat = 0

Format specifyer, either one: PL_IMAGE_LOCAL_FILE PL_IMAGE_BASE64_BMP PL_IMAGE_BASE64_COMPRESSED_BMP PL_IMAGE_EMPTY, $width and height must be passed

PlDocument.$mTransparentColor = -1

Transparent color if PL_DRAWFLAGS_TRANSPARENT is set, format 0x00rrggbb

PlDocument.$mZoom = FALSE

Zoom: may be either FitWidth, ZitHeight, FitAll or a float value as the defualt zoom

PlDocument.$plCoordinate = FALSE

Coordinate object (PlCoordinate), required.

PlDocument.$vPlButton = FALSE

array of buttons, optional

PlDocument.$vPlSlider = FALSE

array of sliders, optional

---

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

• signware_bapi.php