SPAcquire.h File Reference
Detailed Description
SignWare Dynamic Development toolkit, acquire signatures.
- Author:
- uko
Signware also includes an object to capture signatures / references with native GUI, please read Comparison SPAcquire versus SPGuiAcqu for a comparison of SPAcquire and SPGuiAcqu.
SPAcquire
The SPAcquire object captures one or more signatures from a tablet. There is no visual feedback on the pc screen, however displays integrated into the tablet will be updated.SPAcquire adds capabilities to define special regions. These regions will be interpreted as clickable areas. When the user clicks these regions then a callback function will be called.
The acquiry object creates a signature and a reference object. The signature object will be filled during acquiry (as long as acquire mode is active). The signature object will be appended to the reference object if SPAcquireAcquireDone is called with SP_IDOK. In any case, the signature object will not be accessable after calling SPAcquireAcquireDone. The typical usage of the signature object is to check for empty signatures and to deny accepting empty signatures. Always use the created reference object as the result of an acquire operation.
The application must differentiate different types of tablet hardware:
- Standard tablets: these devices have no display, so there is no feedback for users when they hit any special regions. It is not recommended to define special regions on these devices.
- Full-screen tablets: these devices include a screen that typically displays the entire workstation.
SPAcquire does not support Full screen devices - Tablets with integrated screen: these devices integrate a screen that allows for direct feedback of the strokes. These devices also allow for a visual representation of special regions. It is recommended to register rectangles on these devices.
Screen updates on these devices are typically relatively slow, it is not recommended to dynamically update the screen.
The tablet screen cannot be updated when acquiry mode is active. - Tablets which cannot send vectors in real time (SPTabletGetTybletType() returns bit SP_TABLET_NO_REALTIME_VECTORS is set): a GUI should not display a OK-button unless the the user can see the tablet contents.
- The application must evaluate hardware buttons for tablets that are connected through SPTabletServer or tablets that set the flag SP_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS.
These buttons are supported:
- Virtual buttons, see SPAcquireRegisterRect and SPAcquireRegisterRect2
- Note:
- Some low-level tablet drivers use window messages to communicate with the application.
- Wintab uses message ID's in the range WM_USER + 0x7BF0 (0x7FF0) through WM_USER + 0xFBFF (0x7FFF),
- Kofax drivers use message ID's in the range WM_USER + 0x7BD0 (0x7FD0) through WM_USER + 0x7BDF (0x7FDF).
- SPAcquire uses message ID's in the range WM_USER + 0x7BB0 (0x7FB0) through WM_USER + 0x7BBF (0x7FBF).
Description of parameters passed as XML strings
Please see sections Virtual Buttons for more information on virtual button descriptors and background object descriptors.
- Note:
- SPAcquire will ignore elements that are designated to the PC screen (screen=on) and will draw elements designated to the tablet lcd (tablet=on).
Any coordinates with origin window or absscreen may result in undefined behaviour.
Comparison SPAcquire versus SPGuiAcqu
Signware offers two objects to capture signatures or references from a tablet, SPAcquire and SPGuiAcqu.The obvious difference is that SPGuiAcqu includes handling of a native window to render the entered signature in real time.
However more limitations apply to SPAcquire due to the missing GUI:
- Full screen devices such as TabletPC or Wacom Cintiq are not supported
- Tablets without LCD screen are supported but there is no user feedback where the application places virtual buttons
- Native buttons are not supported
- background xml-descriptors do not create a background image for the PC screen
- xml descriptors must not include coordinated with origin window or absscreen
- a message loop must be processed under Windows
- SPGuiAcqu is not yet implemented in Linux
A Tablet-Service application or an application that controls many Tablets, or an application that may want to run independent, not synchronized dialogs on tablet and screen may prefer to use a SPAcquire object.
Supported properties
The table below lists all supported Properties.
Name | Default | Range | Description |
---|---|---|---|
"BackgroundColor" | 0xFFFFFF | Background color, format 0xrrggbb, rr: red, gg: green, bb: blue | |
"ForegroundColor" | 0x000000 | Foreground color, format 0xrrggbb, rr: red, gg: green, bb: blue | |
"PenThickness" | 127 | 1 ... 255 | Pen thickness, see @ref SPTabletSetTabletOption for details |
"MirrorTablet" | false | SPBOOL | Mirror tablet, see @ref SP_DRAW_MIRROR_TABLET for details |
"NoStrokeEcho" | false | SPBOOL | set stroke echo, see @ref SP_VIRTUAL_BUTTON_MODE for details |
"ButtonClickMode" | true | SPBOOL | set button click mode, see @ref SP_VIRTUAL_BUTTON_CLICK for details |
Typedefs | |
typedef int(_cdecl * | pSPACQUIREBUTTON_T )(pSPACQUIRE_T pSpAcquire, SPINT32 iButtonId, SPINT32 iPress) |
Callback function that is called when a hardware button on the tablet is pressed. | |
typedef int(_cdecl * | pSPACQUIREDOCRECTLISTENER_T )(pSPACQUIRE_T pSpAcquire, SPUINT32 uDocId, SPUINT32 uRectId) |
Callback function that is called when a registered rectangle in a document is 'clicked'. | |
typedef int(_cdecl * | pSPACQUIRELINETO_T )(pSPACQUIRE_T pSpAcquire, SPINT32 iX, SPINT32 iY, SPINT32 iPress, SPINT32 iTime) |
Callback function that is called for each vector. | |
typedef int(_cdecl * | pSPACQUIRERECTLISTENER_T )(pSPACQUIRE_T pSpAcquire, SPUINT32 uId) |
Callback function that is called when a registered rectangle is 'clicked'. | |
typedef int(_cdecl * | pSPACQUIRESTATUS_T )(pSPACQUIRE_T pSpAcquire, int iMajor, int iDetail) |
Callback function that is called when the tablet hardware status changes, please read tablet status change notifications for more details. | |
typedef int(_cdecl * | pSPACQUIRETIMEOUT_T )(SPVPTR ulOptParameter) |
Callback function that is called when a timeout occurs. | |
Functions | |
SPINT32 __cdecl | SPAcquireAcquire (pSPACQUIRE_T pSPAcquire) |
Start tablet acquiry mode. | |
SPINT32 __cdecl | SPAcquireAcquireDone (pSPACQUIRE_T pSPAcquire, SPINT32 iResult) |
Terminate tablet acquiry mode. | |
SPINT32 __cdecl | SPAcquireAcquireProcessMessages (pSPACQUIRE_T pSPAcquire) |
Process pending messages if the tablet is in acquiry mode. | |
SPINT32 __cdecl | SPAcquireAcquireWait (pSPACQUIRE_T pSPAcquire) |
Wait until tablet acquiry mode is terminated. | |
SPINT32 __cdecl | SPAcquireAddBackgroundDocument (pSPACQUIRE_T pSpAcquire, const SPCHAR *pszXMLDocumentDescription) |
Add documents to the tablet LCD screen. | |
SPINT32 __cdecl | SPAcquireAddBackgroundImage (pSPACQUIRE_T pSpAcquire, const SPCHAR *pszXMLImageDescription) |
Add images to the tablet LCD screen. | |
SPINT32 __cdecl | SPAcquireAddBackgroundObject (pSPACQUIRE_T pSpAcquire, const SPCHAR *pszXMLDescription) |
Add images, text fields or rectangles to the tablet LCD screen. | |
SPINT32 __cdecl | SPAcquireAddBackgroundText (pSPACQUIRE_T pSpAcquire, const SPCHAR *pszXMLTextDescription) |
Add some text to the tablet LCD screen. | |
SPINT32 __cdecl | SPAcquireClearEntries (pSPACQUIRE_T pSpAcquire, int iFlags) |
Clear all internal signature data of any acquiries of an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireConnect (pSPACQUIRE_T pSPAcquire, SPINT32 iDriver) |
Connect to a tablet specified by driver number. | |
SPINT32 __cdecl | SPAcquireConnectByAlias (pSPACQUIRE_T pSPAcquire, const char *pszTabletAlias) |
Connect to a tablet specified by an alias name. | |
SPINT32 __cdecl | SPAcquireConnectByEnum (pSPACQUIRE_T pSPAcquire, pSPPROPERTYMAP_T spDescriptor) |
Connect to a tablet specified by a descriptor. | |
SPINT32 __cdecl | SPAcquireConnectEx (pSPACQUIRE_T pSPAcquire, const char *pszTabletClass, const char *pszConfig) |
Connect to a tablet specified by class name. | |
SPINT32 __cdecl | SPAcquireCreate (pSPACQUIRE_T *ppSPAcquire, SPINT32 iFlags) |
Create an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireCreateTablet (pSPACQUIRE_T pSPAcquire, SPINT32 iDriver) |
Create the native tablet object that is required to connect to or acquire from the tablet hardware. | |
SPINT32 __cdecl | SPAcquireCreateTabletByAlias (pSPACQUIRE_T pSPAcquire, const char *pszAlias) |
Create a new SPTablet object based on an Alias. | |
SPINT32 __cdecl | SPAcquireCreateTabletByEnum (pSPACQUIRE_T pSPAcquire, pSPPROPERTYMAP_T spDescriptor) |
Create a new SPTablet object based on an enumeration. | |
SPINT32 __cdecl | SPAcquireCreateTabletEx (pSPACQUIRE_T pSPAcquire, const char *pszTabletClass, const char *pszConfig) |
Create a native tablet object specified by class name. | |
SPINT32 __cdecl | SPAcquireDisconnect (pSPACQUIRE_T pSPAcquire) |
Disconnect from a tablet. | |
SPINT32 __cdecl | SPAcquireFree (pSPACQUIRE_T *ppSPAcquire) |
Free all resources used by an SPAcquire object. | |
SPINT32 | SPAcquireGetBackgroundColor (pSPACQUIRE_T pSPAcquire, SPINT32 *piBackgroundColor) |
Get the background color. | |
SPINT32 __cdecl | SPAcquireGetBackgroundImage (pSPACQUIRE_T pSPAcquire, SPINT32 iSource, pSPIMAGE_T *ppImage) |
Get the background image as it is displayed on the tablet. | |
SPINT32 __cdecl | SPAcquireGetBackgroundText (pSPACQUIRE_T pSPAcquire, SPINT32 iSource, SPCHAR **ppszText) |
Get the background text as it is displayed on the tablet. | |
SPINT32 __cdecl | SPAcquireGetBoolProperty (pSPACQUIRE_T pSPAcquire, const SPCHAR *pszName, SPBOOL *pbValue) |
Set a property. | |
SPINT32 __cdecl | SPAcquireGetDrawMode (pSPACQUIRE_T pSpAcquire, SPINT32 *piDrawMode) |
Get the draw mode of an SPAcquire object. | |
SPINT32 | SPAcquireGetForegroundColor (pSPACQUIRE_T pSPAcquire, SPINT32 *piForegroundColor) |
Get the foreground color. | |
SPINT32 __cdecl | SPAcquireGetHwnd (pSPACQUIRE_T pSPAcquire, SPHWND *pHwnd) |
Get the window handle of the message window associated with an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireGetIntProperty (pSPACQUIRE_T pSPAcquire, const SPCHAR *pszName, SPINT32 *piValue) |
Set a property. | |
SPINT32 __cdecl | SPAcquireGetReference (pSPACQUIRE_T pSPAcquire, pSPREFERENCE_T *ppReference) |
Get the reference after a signature or reference acquiry. | |
SPINT32 __cdecl | SPAcquireGetSignature (pSPACQUIRE_T pSPAcquire, pSPSIGNATURE_T *ppSignature) |
Get the signature during acquiry mode. | |
SPINT32 __cdecl | SPAcquireGetTablet (pSPACQUIRE_T pSPAcquire, pSPTABLET_T *ppTablet) |
Get the associated SPTablet object. | |
SPINT32 __cdecl | SPAcquireGetUserLong (pSPACQUIRE_T pSPAcquire, SPVPTR *plUser) |
Get the optional user parameter of an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireRegisterDocumentRect (pSPACQUIRE_T pSpAcquire, SPUINT32 aId, const SPCHAR *pszVirtualButtonDescription) |
Register a virtual button in a document. | |
SPINT32 __cdecl | SPAcquireRegisterRect (pSPACQUIRE_T pSPAcquire, SPUINT32 *pId, pSPRECT_T rcl, SPINT32 iFlags, const SPCHAR *pszName, pSPACQUIRERECTLISTENER_T pRectListener) |
Register a rectangle (virtual button) in acquiry mode. | |
SPINT32 __cdecl | SPAcquireRegisterRect2 (pSPACQUIRE_T pSPAcquire, SPUINT32 *pId, const SPCHAR *pszVirtualButtonDescription, pSPACQUIRERECTLISTENER_T pRectListener) |
Register a rectangle (virtual button) in acquiry mode. | |
SPINT32 __cdecl | SPAcquireRemoveBackgroundObjects (pSPACQUIRE_T pSpAcquire) |
Remove images, text and rectangle fields from the tablet LCD screen. | |
SPINT32 __cdecl | SPAcquireSetActive (pSPACQUIRE_T pSpAcquire, SPBOOL bActive) |
Activate / deactivate the acquire window. | |
SPINT32 | SPAcquireSetBackgroundColor (pSPACQUIRE_T pSPAcquire, SPINT32 iBackgroundColor) |
Set the background color. | |
SPINT32 __cdecl | SPAcquireSetBackgroundImage (pSPACQUIRE_T pSPAcquire, const SPUCHAR *pbImage, SPINT32 iImageLen) |
Set the background image of a tablet that includes an LCD display. | |
SPINT32 __cdecl | SPAcquireSetBackgroundObjects (pSPACQUIRE_T pSpAcquire, pSPBACKGROUNDOBJECTS_T pSpBackgroundObjects) |
Set images, text fields or rectangles to the tablet LCD screen. | |
SPINT32 __cdecl | SPAcquireSetBoolProperty (pSPACQUIRE_T pSPAcquire, const SPCHAR *pszName, SPBOOL bValue) |
Set a property. | |
SPINT32 __cdecl | SPAcquireSetButtonListener (pSPACQUIRE_T pSPAcquire, pSPACQUIRERECTLISTENER_T pRectListener, pSPACQUIREBUTTON_T pButtonListener) |
Set the tablet button listener. | |
SPINT32 __cdecl | SPAcquireSetDocumentContent (pSPACQUIRE_T pSpAcquire, SPINT32 aId, const SPCHAR *pContent, SPINT32 iContent, SPINT32 aFormat) |
Set the content of a document. | |
SPINT32 __cdecl | SPAcquireSetDocumentListener (pSPACQUIRE_T pSpAcquire, pSPACQUIREDOCRECTLISTENER_T pListener) |
Register a virtual button listener for buttons which are assigned to a specific document. | |
SPINT32 __cdecl | SPAcquireSetDrawMode (pSPACQUIRE_T pSpAcquire, SPINT32 iDrawMode) |
Set the mode of an SPAcquire object. | |
SPINT32 | SPAcquireSetForegroundColor (pSPACQUIRE_T pSPAcquire, SPINT32 iForegroundColor) |
Set the foreground color. | |
SPINT32 __cdecl | SPAcquireSetIntProperty (pSPACQUIRE_T pSPAcquire, const SPCHAR *pszName, SPINT32 iValue) |
Set a property. | |
SPINT32 __cdecl | SPAcquireSetStatusListener (pSPACQUIRE_T pSpAcquire, pSPACQUIRESTATUS_T pNotifyStatus) |
Set a status listener of an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireSetTimeout (pSPACQUIRE_T pSpAcquire, pSPACQUIRETIMEOUT_T pTimeoutListener, SPVPTR ulOptParameter, SPINT32 iTimeout) |
Set the timeout of an acquiry of an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireSetUserLong (pSPACQUIRE_T pSPAcquire, SPVPTR lUser) |
Set the optional user parameter of an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireSetVectorListener (pSPACQUIRE_T pSpAcquire, pSPACQUIRELINETO_T pNotifyVector) |
Set a vector listener of an SPAcquire object. | |
SPINT32 __cdecl | SPAcquireUnregisterAllRects (pSPACQUIRE_T pSPAcquire) |
Unregister all rectangles (virtual buttons) in acquiry mode. | |
SPINT32 __cdecl | SPAcquireUnregisterRect (pSPACQUIRE_T pSPAcquire, SPUINT32 uId) |
Unregister a rectangle (virtual button) in acquiry mode. |
Typedef Documentation
|
Callback function that is called when a hardware button on the tablet is pressed. A pointer to a function that is called to notify the application about a hardware button being pressed during acquiry mode.
|
|
Callback function that is called when a registered rectangle in a document is 'clicked'.
|
|
Callback function that is called for each vector. A pointer to a function that is called for every significant vector (sample) received from the tablet in acquiry mode.
|
|
Callback function that is called when a registered rectangle is 'clicked'.
|
|
Callback function that is called when the tablet hardware status changes, please read tablet status change notifications for more details. A pointer to a function that is called to notify the application about tablet hardware status changes.
|
|
Callback function that is called when a timeout occurs. A pointer to a function that is called to notify the application about a timeout condition during acquiry mode.
|
Function Documentation
|
Start tablet acquiry mode. Switch the tablet into acquiry mode. SPTablet switches the tablet from pointer mode to pen entry mode during acquiry. Any registered rectangles will be notified in pen entry mode when the pen is pressed on a rectangle. Pen entry mode is exclusive and will not send any pointer move notifications to any application. This function enables aquiry mode and returns immediately. The actual state change of the tablet is signaled by callback functions, see SPAcquireSetStatusListener. Further callbacks are called during aquiry mode, see SPAcquireSetTimeout, SPAcquireRegisterRect, SPAcquireRegisterRect2, SPAcquireSetButtonListener. Events resulting in callbacks being called are stored in a queue. If SP_GAWW_EVENTS was set in iFlags of SPAcquireCreate, the system's queue will be used, that is, either the Windows message queue (for Windows) or the X11 event queue (for X11, not yet implemented). If SP_GAWW_EVENTS was not set in iFlags of SPAcquireCreate, an event queue internal to SignWare will be used. In all cases, the queue must be read. This is done by
|
|
Terminate tablet acquiry mode. Turn off tablet aquiry mode. This function makes SPAcquireAcquireWait return.
|
|
Process pending messages if the tablet is in acquiry mode. This function processes messages (or events) while in acquiry mode. SPAcquireAcquireProcessMessages returns as soon as all pending messages (or events) for this object have been processed whereas SPAcquireAcquireWait does not return until SPAcquireAcquireDone is called. This function runs a message loop under Windows.
|
|
Wait until tablet acquiry mode is terminated. This function processes messages (or events) and waits until SPAcquireAcquireDone is called in acquiry mode. Applications that do not run a message loop must call either SPAcquireAcquireWait or periodically call SPAcquireAcquireProcessMessages to dispatch the messages for this object. This function runs a message loop under Windows. Under Linux it waits for signature capture completion. Signature capture completion is signalled by SPAcquireAcquireDone.
|
|
Add documents to the tablet LCD screen. The XML string is described in Image fields, element SPSWDocumentFields must be used. The Objects will be displayed on an (optional) LCD screen when the application calls SPAcquireAcquire
|
|
Add images to the tablet LCD screen. The XML string is described in Image fields, element SPSWImageFields must be used. The Objects will be displayed on an (optional) LCD screen when the application calls SPAcquireAcquire
|
|
Add images, text fields or rectangles to the tablet LCD screen. The XML string is described in Mixed image, document and text fields. Element SPSWObjects must be the root element, SPSWImageFileds, SPSWImage, SPSWRect, SPSWRectFields, SPSWTextFields and SPSWText elements will be displayed.
|
|
Add some text to the tablet LCD screen. The XML string is described in Text fields, element SPSWTextFields must be used. The Objects will be displayed on an (optional) LCD screen when the application calls SPAcquireAcquire
|
|
Clear all internal signature data of any acquiries of an SPAcquire object. This function will clear the SPReference object that is embedded in this object; this means that all signatures that were entered so far will be deleted. This function may be required to reenter a signature / reference when the prior entry was not accepted, e.g., because the reference did not satisfy the quality criteria.
|
|
Connect to a tablet specified by driver number. The creation of a tablet object will fail if the connected tablet is a full screen device such as TabletPC or Wacom Cintiqu. Full screen devices are not supported with SPAcquire objects. Please read Comparison SPAcquire versus SPGuiAcqu for more details. Please read Tablet creation options for a list of supported drivers
|
|
Connect to a tablet specified by an alias name. Please read Tablet creation options for resolving the Alias
|
|
Connect to a tablet specified by a descriptor. Please read Tablet creation options for tablet enumeration
|
|
Connect to a tablet specified by class name. The creation of a tablet object will fail if the connected tablet is a full screen device such as TabletPC or Wacom Cintiqu. Full screen devices are not supported with SPAcquire objects. Please read Comparison SPAcquire versus SPGuiAcqu for more details. Please read Tablet creation options for a list of supported options
|
|
Create an SPAcquire object. Under Windows an invisible message window will be created. You can query the handle of that window by calling SPAcquireGetHwnd. If SP_GAWW_EVENTS is set in iFlags, SPAcquire sends messages with ID's starting at WM_USER + 1000 to that message window. The creation of a tablet object will fail if the connected tablet is a full screen device such as TabletPC or Wacom Cintiqu. Under Windows most tablets, especially tablet using a Wintab driver, send vector notifications through as message events, which reqire message loop. Therefore, SP_GAWW_EVENTS must be set under Windows. Please see section SPAcquire for more information about message event IDs.
|
|
Create the native tablet object that is required to connect to or acquire from the tablet hardware. This is a convenience function provided for applications that might need to access the tablet driver before it is connected. The tablet driver object will be created when it is internally required, the application does not have to call this function. A typical use for this function would be to select an image depending on the tablet device. Create the tablet driver object, get the device ID, pass the device-specific image, and then connect to the tablet. The creation of a tablet object will fail if the connected tablet is a full screen device such as TabletPC or Wacom Cintiqu. Full screen devices are not supported with SPAcquire objects. Please read Comparison SPAcquire versus SPGuiAcqu for more details. Please read Tablet creation options for a list of supported drivers
|
|
Create a new SPTablet object based on an Alias. Please read Tablet creation options for resolving the Alias
|
|
Create a new SPTablet object based on an enumeration. Please read Tablet creation options for tablet enumeration.
|
|
Create a native tablet object specified by class name. This function will not reinstantiate the tablet driver if a driver already exists. This is a convenience function provided for applications that might need to access the tablet driver before it is connected. In most other cases the tablet driver object will be created when it is internally required, the application does not have to call this function. A typical application of this function would be to select an image depending on the tablet device. Create the tablet driver object, get the device ID, pass the device specific image, and then connect to the tablet. The creation of a tablet object will fail if the connected tablet is a full screen device such as TabletPC or Wacom Cintiqu. Full screen devices are not supported with SPAcquire objects. Please read Comparison SPAcquire versus SPGuiAcqu for more details. Please read Tablet creation options for a list of supported options
|
|
Disconnect from a tablet.
|
|
Free all resources used by an SPAcquire object. The SPAcquire object must have been created by SPAcquireCreate It is an error to free an SPAcquire object while processing a windows message for the window handle assigned to that SPAcquire object.
|
|
Get the background color.
|
|
Get the background image as it is displayed on the tablet. The image will not contain any partial or fully entered signature strokes. This function returns SP_NOERR and *ppImage = NULL if no background image was passed. This function is provided for audit purposes. The resulting image contains a gray-scale image with up to 256 gray levels or a color image.
|
|
Get the background text as it is displayed on the tablet. This function returns SP_NOERR and *ppText = NULL if no background text was passed. This function is provided for audit purposes. The resulting text contains all text elements that is diplayed on the tablet.
|
|
Set a property.
|
|
Get the draw mode of an SPAcquire object.
|
|
Get the foreground color.
|
|
Get the window handle of the message window associated with an SPAcquire object. This function returns the handle of the invisible message-only window created by SPAcquireCreate.
|
|
Set a property.
|
|
Get the reference after a signature or reference acquiry. The returned reference may contain a single signature (in this case a signature was captured), or multiple signatures (when a true reference was captured). It is the responsability of the application to convert the reference to a signature if the returned object includes a single signature. This is a convenience function which behaves exactly like SPReferenceCreateFromAcquire. The captured signature will be added to the the reference object during processing of SPAcquireDone.
|
|
Get the signature during acquiry mode. The returned SPSignature object may not contain all vectors captured so far. This function is provided to check for empty signatures before accepting the signature (see SPAcquireAcquireDone). Modifying the SPSignature object won't have an effect on the signature being captured. This is a convenience function which behaves exactly like SPSignatureCreateFromAcquire. No signature object will be returned unless the SPAcquire object is in acquiry mode.
|
|
Get the associated SPTablet object. SP_PARAMERR will be returned if the tablet has not yet been created. You should neither register any listeners in the returned tablet nor set any properties. The object is available to query tablet proerties such as tablet type, size etc. only.
|
|
Get the optional user parameter of an SPAcquire object.
|
|
Register a virtual button in a document.
|
|
Register a rectangle (virtual button) in acquiry mode. This function is a simplified version of SPAcquireRegisterRect2, the call is actually dispatched to SPAcquireRegisterRect2 with a properly formatted XML description string. Any registered rectangles will be notified in acquiry mode when the pen is pressed on a rectangle. You must assure that the rectangles will be updated whenever the coordinates change, such as resizing or moving a component unless you specify the flag SP_TABLET_COORDINATE. Rectangles can only be drawn to an optional LCD screen on the tablet if they are registered before the tablet enters acquiry mode. The SPAcquire object should not be deleted within the registered listener. You may, e.g., post a message and delete the object in the windows procedure handling that message.
|
|
Register a rectangle (virtual button) in acquiry mode. Any registered rectangles will be notified in acquiry mode when the pen is pressed on a rectangle. Rectangles can only be drawn to an optional LCD screen on the tablet if they are registered before the tablet enters acquiry mode. TextFields will be positioned within the rectangle (centered, excluding optional image space) if no valid coordinate is specified. Images will be positioned within the rectangle (left aligned) if no valid coordinate is specified.
|
|
Remove images, text and rectangle fields from the tablet LCD screen. The Background Objects will be updated on an (optional) LCD screen when the application calls SPAcquireAcquire
|
|
Activate / deactivate the acquire window. The acquire window is normally active until SPAcquireAcquireDone is called. There may be situations where the application might want to deactivate acquire mode, e.g. in multi page dialogs.
|
|
Set the background color. The background color is used to draw a pen stroke that has zero pressure. It will also be used to erase the background if SP_ERASE_BACKGROUND is set.
|
|
Set the background image of a tablet that includes an LCD display. The tablet image is composed of all background images, text and rectangles (virtual buttons). The tablet image will be calculated before the tablet enters acquiry mode, that is within the method SPAcquireAcquire.
|
|
Set images, text fields or rectangles to the tablet LCD screen. Use SPBackgroundObjectsCreateFromFile or SPBackgroundObjectsCreateFromXML to create the background objects container. The proper objects will be selected based on the created tablet type, and all elements of the selected objects will be copied to the background
|
|
Set a property.
|
|
Set the tablet button listener. This listener will be called when a real button on the tablet was pressed, but not for virtual buttons.
|
|
Set the content of a document.
Use SPAcquireAddBackgroundDocument or SPAcquireAddBackgroundObject or SPAcquireSetBackgroundObjects to create and layout of a document view.
|
|
Register a virtual button listener for buttons which are assigned to a specific document.
|
|
Set the mode of an SPAcquire object.
|
|
Set the foreground color. The foreground color is used to draw a pen stroke that has maximum pressure.
|
|
Set a property.
|
|
Set a status listener of an SPAcquire object.
|
|
Set the timeout of an acquiry of an SPAcquire object. The timeout handler will be called if there was no pen stroke for the duration of iTimeout in milliseconds.
|
|
Set the optional user parameter of an SPAcquire object. The optional user parameter is not used inside SignWare, you may add one additional SPVPTR parameter for application purposes.
|
|
Set a vector listener of an SPAcquire object.
|
|
Unregister all rectangles (virtual buttons) in acquiry mode.
|
|
Unregister a rectangle (virtual button) in acquiry mode.
|