PlButton Class Reference

List of all members.

---

Detailed Description

Button element.

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

Public Member Functions
	loadIconFile ($aName)
	Load an icon file on the server.
	PlButton ($c="", $f=-1)
	Constructor.
	readXML (&$xml)
	Read an XML descriptor.
	setIcon ($aIcon)
	set the Icon of a PlButton
	writeXML (&$xml)
	Write the XML descriptor.
Public Attributes
	$mBgColor = FALSE
	optional background color, integer, optional
	$mCaption = ""
	Caption text, UTF8 String.
	$mEncoding = FALSE
	Encoding of the Icon, use setIcon or loadIconFile to set $mEncoding, String.
	$mFgColor = FALSE
	optional foreground color, integer, optional
	$mFlags = 0
	Display flags a combination of PL_DRAWFLAGS_PLUGINWND or PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen PL_DRAWFLAGSLCD, draw the button on the tablet LCD PL_BUTTON_PEN, button is clickable with the tablet pen PL_BUTTON_MOUSE, button is clickable with the mouse
	$mIcon = FALSE
	Icon data for the button, use setIcon or loadIconFile to set $mIcon, String.
	$mToolTip = FALSE
	optional tooltip text, UTF8 String, optional
	$plAction = false
	Action object (PlAction), required.
	$plCoordinate = false
	Coordinate object (PlCoordinate), required.
	$plFont = false
	Font object (PlFont), optional.

---

Constructor & Destructor Documentation

PlButton.PlButton (  $  c = "", $  f = -1 )

Constructor. Parameters: $c  [i] caption text $f  [i] flags, see $flags

---

Member Function Documentation

PlButton.loadIconFile (  $  aName  )

Load an icon file on the server. Parameters: $aName  relative image path on the server Exceptions: Exception  on errors such as file not found Note: loadIconFile sets $mIcon and $mFormat An Icon must be in Windows Icon format (ICO). An Icon is composed of a Bitmap describing the icon and a 1 bit per Pixel mask. An Icon file may include more than one Bitmap / Mask pairs, e. g. in different sizes or different states.

PlButton.readXML (  &$  xml  )

Read an XML descriptor.

PlButton.setIcon (  $  aIcon  )

set the Icon of a PlButton Parameters: $aIcon  [i] String, the icon data Note: loadIconFile sets $mIcon and $mFormat An Icon must be in Windows Icon format (ICO). An Icon is composed of a Bitmap describing the icon and a 1 bit per Pixel mask. An Icon file may include more than one Bitmap / Mask pairs, e. g. in different sizes or different states.

PlButton.writeXML (  &$  xml  )

Write the XML descriptor.

---

Member Data Documentation

PlButton.$mBgColor = FALSE

optional background color, integer, optional

PlButton.$mCaption = ""

Caption text, UTF8 String.

PlButton.$mEncoding = FALSE

Encoding of the Icon, use setIcon or loadIconFile to set $mEncoding, String.

PlButton.$mFgColor = FALSE

optional foreground color, integer, optional

PlButton.$mFlags = 0

Display flags a combination of PL_DRAWFLAGS_PLUGINWND or PL_DRAWFLAGS_DRAWWND or PL_DRAWFLAGS_IMAGE, draw the button on the PC screen PL_DRAWFLAGSLCD, draw the button on the tablet LCD PL_BUTTON_PEN, button is clickable with the tablet pen PL_BUTTON_MOUSE, button is clickable with the mouse

PlButton.$mIcon = FALSE

Icon data for the button, use setIcon or loadIconFile to set $mIcon, String.

PlButton.$mToolTip = FALSE

optional tooltip text, UTF8 String, optional

PlButton.$plAction = false

Action object (PlAction), required.

PlButton.$plCoordinate = false

Coordinate object (PlCoordinate), required.

PlButton.$plFont = false

Font object (PlFont), optional.

---

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

• signware_bapi.php