visit Kofax web site

ACTIVESWLib::_ISPAcquireEvents Interface Reference


Detailed Description

Interface _ISPAcquireEvents.

Acquire callback events

Note:
Registered event listeners persistence is bound to the lifetime of the associated ISPAcquire object, independent of the native object.


Public Member Functions

long buttonPressed ([in] long lId)
 notification a button was pressed in a SPAcquire object
long documentEvent ([in] long lDocumentID,[in] long lRectID)
 notification a virtual button on a document was clicked
long rectPressed ([in] long lId)
 notification a virtaul button (rect) was pressed in a SPAcquire object
long statusChanged ([in] long lMajor,[in] long lDetail)
 notification the hardware status of the connected tablet changed, please read tablet status change notifications for more details.
long tabletVector ([in] long lX,[in] long lY,[in] long lP,[in] long lT)
 notification a vector was passed from the tablet
long timeout ()
 notification a timeout has occured in a SPAcquire object


Member Function Documentation

long ACTIVESWLib::_ISPAcquireEvents::buttonPressed [in] long  lId  ) 
 

notification a button was pressed in a SPAcquire object

Parameters:
lId Identifier of the button. The value depends on the tablet, see Tablet Hardware button Assignment
Returns:
SPX_NOERR on success, else error code
See also:
SPAcquireSetButtonListener

long ACTIVESWLib::_ISPAcquireEvents::documentEvent [in] long  lDocumentID,
[in] long  lRectID
 

notification a virtual button on a document was clicked

Parameters:
lDocumentID [i] identifier of the document
lRectID [i] identifier of the virtual button within the document
Returns:
SPX_NOERR on success, else error code
See also:
SPAcquireSetDocumntListener

long ACTIVESWLib::_ISPAcquireEvents::rectPressed [in] long  lId  ) 
 

notification a virtaul button (rect) was pressed in a SPAcquire object

Parameters:
lId Identifier of the rect
Returns:
SPX_NOERR on success, else error code
See also:
ISPAcquire::RegisterRect2

long ACTIVESWLib::_ISPAcquireEvents::statusChanged [in] long  lMajor,
[in] long  lDetail
 

notification the hardware status of the connected tablet changed, please read tablet status change notifications for more details.

Parameters:
lMajor [i] Major event descriptor
lDetail [i] Detail event descriptor
Returns:
SPX_NOERR on success, else error code
See also:
SPAcquireSetStatusListener

long ACTIVESWLib::_ISPAcquireEvents::tabletVector [in] long  lX,
[in] long  lY,
[in] long  lP,
[in] long  lT
 

notification a vector was passed from the tablet

Note:
Tablet vectors are handled by SPAcquire objects, the application will typically ignore vector notifications.
Parameters:
lX [i] X-coordinate
lY [i] Y-coordinate
lP [i] pressure level
lT [i] timestamp, may be -1 if not measured
Returns:
SPX_NOERR on success, else error code
See also:
SPAcquireSetVectorListener

long ACTIVESWLib::_ISPAcquireEvents::timeout  ) 
 

notification a timeout has occured in a SPAcquire object

Returns:
SPX_NOERR on success, else error code
See also:
ISPAcquire::SetTimeout


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