visit Kofax web site

PlAction Class Reference

List of all members.

Detailed Description

Action object, an action is defined by an identifyer, an optional integer value and an optional string value.

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


Public Member Functions

 PlAction ($i=PL_ACTION_OK, $u=false, $v=false)
 Constructor.
 readXML (&$xml)
 Read an XML descriptor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mId = PL_ACTION_OK
 Action identifier, see PL_ACTION_xxxx macros.
 $miValue = FALSE
 Optional int parameter.
 $mLastSaved = FALSE
 Reload the last recently saved Value for this Action, boolean, optionally.
 $mName = FALSE
 Name of an Action, required for TextEntry fields and toggle-buttons.
 $mstrValue = FALSE
 Optional UTF8 string parameter.


Constructor & Destructor Documentation

PlAction.PlAction i = PL_ACTION_OK,
u = false,
v = false
 

Constructor.

Parameters:
$i [i] action id, see $id
$u [i] URL for sendto action
$v [i] value, optional, currently not used


Member Function Documentation

PlAction.readXML &$  xml  ) 
 

Read an XML descriptor.

PlAction.writeXML &$  xml  ) 
 

Write the XML descriptor.


Member Data Documentation

PlAction.$mId = PL_ACTION_OK
 

Action identifier, see PL_ACTION_xxxx macros.

PlAction.$miValue = FALSE
 

Optional int parameter.

PlAction.$mLastSaved = FALSE
 

Reload the last recently saved Value for this Action, boolean, optionally.

PlAction.$mName = FALSE
 

Name of an Action, required for TextEntry fields and toggle-buttons.

PlAction.$mstrValue = FALSE
 

Optional UTF8 string parameter.


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