SPTablet.h File Reference
Detailed Description
SignWare Dynamic Development toolkit, tablet access.
- Author:
- uko
The object SPTabletEnum enumerates all tablets for either a specific driver or all drivers. You may use an enumeration object to create the specific tablet,
- See also:
- SPTabletCreateByEnum.
- Select driver with SPTabletCreate, SPTabletCreateByAlias, SPTabletCreateEx, SPTabletCreateByEnum
- Register listeners with SPTabletSetListeners
- Connect to the tablet with SPTabletConnect
- Set background image with SPTabletSetBackgroundImage, optionally set acuire flags such asSP_DONT_ECHO_STROKES with SPTabletSetFlags
- Enter acquiry mode with SPTabletAcquire
- Process tablet vectors (samples) as they are sent to the listeners
- Exit acquiry mode when done by calling SPTabletAcquireDone
- Process the sample rate with SPTabletGetSampleRate and the timestamp with SPTabletGetTimeStamp
- If more than 1 signature shall be captured then repeat the steps starting with set background image for each signature.
- Disconnect from the tablet with SPTabletDisconnect
- Deallocate the SPTablet object with SPTabletFree
Please assure that these message ID's do not conflict with message ID's in your application.
SPTablet normalizes the data passed from different tablets, applications will not have to care about the attached device. The normalisation covers:
- pressure: all pressure levels are normalized to a range 0 ... 1023
- coordinates: all coordinates are transformed according to the specified resolution [in DPI]
- background images: images are scaled to fit the display device (if applicable)
Tablet Status Change Notifications
Some tablet drivers cannot execute status changes synchronously but have to dispatch the status request and perform the requested operation later. This applies e. g. to TabletPCs, which cannot directy enter acquiry state but post a message to the assigned native window handle and change the state when processing the message.Errors and warnings can thus not be returned to the application directly, the application will be informed via status change notification / callback.
The callback passes two parameters to describe the event: a major number and a detail number.
These notifications are passed:
Major reason for the event.
- 1 An error occured
- 2 A warning occured
- 3 A information message
- 0x400 a special event from eSignature Pad (Wacom SignPad)
- 0x401 a special event from Kofax TabletServer driver
Detail information for the event The value depends on the major event type:
- 1 (Error):
- SP_NOPADERR The pad did not respond or was disconnected, application should terminate acquiry
- SP_CANCELERR aborted, only SPTabletServer driver, may be same as cancel button, application should camcel the operation
- SP_UNSUPPORTEDERR unspecified internal error occured, only SPTabletServer driver, application should terminate acquiry
- SP_APPLERR unexpected data is passed, only SPTabletServer driver, application should terminate acquiry
- SP_INVALIDERR invalid configuration, only SPTabletServer driver, application should terminate acquiry
- 2 (Warning) currently not used
- 3 (Information) currently not used
- 0x400 (eSignature Pad, Wacom SignPad)
- SP_CRYPTERR Key negotiation failed, vector data is exchanged unencrypted
- SP_UNSUPPORTEDERR The tablet does not support encrypted data exchange
- SP_INTERR an internal error occured, unexpected tablet state, application should terminate acquiry
- SP_DIBERR wrong background image
- 0x401 (SPTabletServer)
- SP_DIBERR wrong background image
- SP_TIMEOUTERR Timeout, no stroke after timeout mseconds, can be handled as OK button
Defines | |
#define | SP_ACQUIRE_RETURN_IMMEDIATELY 2 |
Flag for SPTabletSetFlags: return immediately from SPTabletAcquire. | |
#define | SP_ACQUIRE_TRANSFER_0_VECTORS 8 |
Flag for SPTabletSetFlags: send all vectors having a pressure value of 0. | |
#define | SP_DONT_ECHO_STROKES 0x10 |
Flag for SPTabletSetFlags: don't echo strokes on the tablet LCD. | |
#define | SP_SYNCHRONOUS_START_ACQUIRE 0x40 |
Flag for SPTabletSetFlags: execute SPTabletStartAcquire synchronously. | |
#define | SP_TABLET_STATE_ACQUIRE 2 |
Tablet state: acquiring. | |
#define | SP_TABLET_STATE_CONNECT 1 |
Tablet state: connected. | |
#define | SP_TABLET_STATE_IDLE 0 |
Tablet state: idle. | |
Typedefs | |
typedef int(_cdecl * | pSPENDNOTIFY_T )(pSPTABLET_T pTablet) |
Callback function that is called after sending one or more vectors. | |
typedef int(_cdecl * | pSPLINETO2_T )(pSPTABLET_T pTablet, SPINT32 iX, SPINT32 iY, SPINT32 iPress, SPINT32 iTime) |
Callback function that is called for each vector. | |
typedef int(_cdecl * | pSPLINETO_T )(pSPTABLET_T pTablet, SPINT32 iX, SPINT32 iY, SPINT32 iPress) |
Callback function that is called for each vector. | |
typedef int(_cdecl * | pSPSTARTNOTIFY_T )(pSPTABLET_T pTablet) |
Callback function that is called when vectors are available. | |
typedef int(_cdecl * | pSPTABLETBUTTON_T )(pSPTABLET_T pTablet, SPINT32 iButtonId, SPINT32 iPress) |
Callback function that is called when a hardware button is pressed on the tablet. | |
typedef int(_cdecl * | pSPTABLETSTATUS_T )(pSPTABLET_T pTablet, SPINT32 iMajor, SPINT32 iMinor) |
Callback function that is called when the status of a tablet changes, please read tablet status change notifications for more details. | |
Functions | |
SPINT32 __cdecl | SPTabletAcquire (pSPTABLET_T pTablet, SPHWND hwndParent) |
Put an SPTablet object into acquiry mode. | |
SPINT32 __cdecl | SPTabletAcquireDone (pSPTABLET_T pTablet) |
Terminate acquiry mode of an SPTablet object. | |
SPINT32 __cdecl | SPTabletClearBackgroundImage (pSPTABLET_T pTablet, SPINT32 iImFlags) |
Clear the background image of an SPTablet object. | |
SPINT32 __cdecl | SPTabletConnect (pSPTABLET_T pTablet) |
Connect an SPTablet object to a tablet. | |
SPINT32 __cdecl | SPTabletCreate (pSPTABLET_T *ppTablet, SPINT32 iDriverId) |
Create a new SPTablet object. | |
SPINT32 __cdecl | SPTabletCreateByAlias (pSPTABLET_T *ppTablet, const char *pszAlias) |
Create a new SPTablet object based on an Alias. | |
SPINT32 __cdecl | SPTabletCreateByEnum (pSPTABLET_T *ppTablet, pSPPROPERTYMAP_T spDescriptor) |
Create a new SPTablet object. | |
SPINT32 __cdecl | SPTabletCreateEx (pSPTABLET_T *ppTablet, const char *pszTabletClass, const char *pszConfig) |
Create a new SPTablet object. | |
SPINT32 __cdecl | SPTabletDisconnect (pSPTABLET_T pTablet) |
Disconnect a tablet from an SPTablet object. | |
SPINT32 __cdecl | SPTabletFree (pSPTABLET_T *ppTablet) |
Deallocate an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetDevice (pSPTABLET_T pTablet, SPINT32 *piDevice) |
Get the device ID of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetDeviceStr (SPINT32 iDeviceId, SPCHAR *pszName, SPINT32 iNameLen) |
Get the name of the tablet device. | |
SPINT32 __cdecl | SPTabletGetDisplayType (pSPTABLET_T pTablet, SPINT32 *piDisplayType) |
Query the display type of the tablet used by this SPTablet object. | |
SPINT32 __cdecl | SPTabletGetDriver (pSPTABLET_T pTablet, SPINT32 *piDriver) |
Get the driver ID of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetDriverStr (SPINT32 iDriverId, SPCHAR *pszName, SPINT32 iNameLen) |
Get the name of a tablet driver. | |
SPINT32 __cdecl | SPTabletGetFlags (pSPTABLET_T pTablet, SPINT32 *piFlags) |
Get the tablet flags for acquiry mode of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetHardwareName (pSPTABLET_T pTablet, SPCHAR *pszHardwareName, SPINT32 iHardwareNameLen) |
Get the hardware file name of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetLCD (pSPTABLET_T pTablet, SPINT32 *piLCD) |
Check if the tablet used by an SPTablet object is a full-screen tablet. | |
SPINT32 __cdecl | SPTabletGetLCDBitsPerPixel (pSPTABLET_T pTablet, SPINT32 *piBitsPerPixel) |
Get the bit depth of the LCD of the tablet. | |
SPINT32 __cdecl | SPTabletGetLCDOffset (pSPTABLET_T pTablet, SPINT32 *piOffsetX, SPINT32 *piOffsetY) |
Get the offset of the LCD of the tablet used by an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetLCDSize (pSPTABLET_T pTablet, SPINT32 *piWidth, SPINT32 *piHeight) |
Get the size of the LCD of the tablet used by an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetMaxPressure (pSPTABLET_T pTablet, SPINT32 *piMaxPressure) |
Get the pressure range of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetPadSerial (pSPTABLET_T pTablet, SPUCHAR *pbPadSerial, SPINT32 *piPadSerialLength) |
Get the tablet serial ID of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetPhysicalSize (pSPTABLET_T pTablet, SPINT32 *piWidth, SPINT32 *piHeight) |
Get the tablet size of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetResolution (pSPTABLET_T pTablet, SPINT32 *piResolution) |
Get the logical resolution of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetResolution2 (pSPTABLET_T pTablet, SPINT32 iDetail, SPINT32 *piResolution) |
Get the resolution of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetSampleRate (pSPTABLET_T pTablet, SPINT32 *piSampleRate) |
Get the logical sample rate of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetSampleRate2 (pSPTABLET_T pTablet, SPINT32 iDetail, SPINT32 *piSampleRate) |
Get the sample rate of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetState (pSPTABLET_T pTablet, SPINT32 *piState) |
Get the state of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetTabletSize (pSPTABLET_T pTablet, SPINT32 *piWidth, SPINT32 *piHeight) |
Get the tablet size of an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetTabletType (pSPTABLET_T pTablet, SPINT32 *piType) |
Query the tablet type. | |
SPINT32 __cdecl | SPTabletGetTimeStamp (pSPTABLET_T pTablet, SPUINT32 *puTimeStamp) |
Get the timestamp of the signature. most recently acquired by an SPTablet object. | |
SPINT32 __cdecl | SPTabletGetUserLong (pSPTABLET_T pTablet, SPVPTR *plUserLong) |
Get the optional user parameter of an SPTablet object. | |
SPINT32 __cdecl | SPTabletHasExternalLCD (pSPTABLET_T pTablet, SPINT32 *piExtLCD) |
Check if the tablet used by an SPTablet object has an integrated LCD. | |
SPINT32 __cdecl | SPTabletHasProximity (pSPTABLET_T pTablet, SPINT32 *piProximity) |
Get the proximity capability of an SPTablet object. | |
SPINT32 __cdecl | SPTabletReloadParameters (pSPTABLET_T pTablet) |
Reload the tablet characteristics. | |
SPINT32 __cdecl | SPTabletReset (SPBOOL bReset) |
Reset all tablet drivers. | |
SPINT32 __cdecl | SPTabletSetBackgroundImage (pSPTABLET_T pTablet, const SPUCHAR *pbImageData, SPINT32 iImageDataLen) |
Set the background image of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetBackgroundImage2 (pSPTABLET_T pTablet, SPINT32 iImFlags, const SPUCHAR *pbImageData, SPINT32 iImageDataLen) |
Set the background image of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetButtonListener (pSPTABLET_T pTablet, pSPTABLETBUTTON_T pNotifyButton) |
Set the hardware button listener of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetClipRectangle (pSPTABLET_T pTablet, SPINT32 iLeft, SPINT32 iTop, SPINT32 iRight, SPINT32 iBottom) |
Set the clipping rectangle for the tablet display. | |
SPINT32 __cdecl | SPTabletSetDevice (pSPTABLET_T pTablet, SPINT32 iDevice) |
Set the device ID of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetDisplayType (pSPTABLET_T pTablet, SPINT32 iDisplayType) |
Set the display type of the tablet used by this SPTablet object. | |
SPINT32 __cdecl | SPTabletSetDriver (pSPTABLET_T pTablet, SPINT32 iDriver) |
Set the driver ID of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetFlags (pSPTABLET_T pTablet, SPINT32 iFlags) |
Set the tablet flags for acquiry mode of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetLCD (pSPTABLET_T pTablet, SPINT32 iLCD) |
Change an SPTablet object's notion of the presence of a full-screen tablet. | |
SPINT32 __cdecl | SPTabletSetListeners (pSPTABLET_T pTablet, pSPSTARTNOTIFY_T pStartNotify, pSPLINETO_T pLineTo, pSPENDNOTIFY_T pEndNotify) |
Set listeners of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetListeners2 (pSPTABLET_T pTablet, pSPSTARTNOTIFY_T pStartNotify, pSPLINETO2_T pLineTo, pSPENDNOTIFY_T pEndNotify) |
Set listeners of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetMaxPressure (pSPTABLET_T pTablet, SPINT32 iMaxPressure) |
Set the pressure range of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetPadSerial (pSPTABLET_T pTablet, const SPUCHAR *pbPadSerial, SPINT32 iPadSerialLength) |
Set the tablet serial ID of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetResolution (pSPTABLET_T pTablet, SPINT32 iResolution) |
Set the resolution of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetSampleRate (pSPTABLET_T pTablet, SPINT32 iSampleRate) |
Set the sample rate of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetStatusListener (pSPTABLET_T pTablet, pSPTABLETSTATUS_T pNotifyStatus) |
Set the hardware status listener of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetTabletOption (pSPTABLET_T pTablet, const SPCHAR *pszName, SPINT32 iValue) |
Set a tablet parameter. | |
SPINT32 __cdecl | SPTabletSetTabletSize (pSPTABLET_T pTablet, SPINT32 iWidth, SPINT32 iHeight) |
Set the tablet size of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSetTicket (pSPTABLET_T pTablet, pSPTICKET_T pTicket) |
Pass a license ticket for the next signature capture(s). | |
SPINT32 __cdecl | SPTabletSetUserLong (pSPTABLET_T pTablet, SPVPTR lUserLong) |
Set the optional user parameter of an SPTablet object. | |
SPINT32 __cdecl | SPTabletSwitchSerialType (pSPTABLET_T pTablet, SPINT32 iSerialType) |
Chooses a different type of serial ID to be returned by SPTabletGetSerial. |
Define Documentation
|
Flag for SPTabletSetFlags: return immediately from SPTabletAcquire. If this flag is set, SPTabletAcquire will return immediately. If this flag is not set, SPTabletAcquire will not return until SPTabletAcquireDone is called. SPTabletAcquireDone must be called in either case.
|
|
Flag for SPTabletSetFlags: send all vectors having a pressure value of 0. If this flag is set, SPTabletAcquire will send all vectors (samples) that have a pressure value of 0. If this flag is not set, SPTabletAcquire will send only one vector having a pressure value of 0 for a sequence of vectors having a pressure value of 0.
|
|
Flag for SPTabletSetFlags: don't echo strokes on the tablet LCD. If this flag is set, strokes won't be echoed to the tablet LCD. If this flag is not set, strokes will be echoed to the tablet LCD This flag is ignored for tablets that don't have an LCD.
|
|
Flag for SPTabletSetFlags: execute SPTabletStartAcquire synchronously. Some tablet drivers require windows messages posted to finally start acquiry mode. The normal behaviour is to post the messages and return. Set this flag if you want the SPTablet object to wait until the messages have been processed (SPTablet will then process and dispatch windows messages). This flag is currently ignored under Linux.
|
|
Tablet state: acquiring.
|
|
Tablet state: connected.
|
|
Tablet state: idle.
|
Typedef Documentation
|
Callback function that is called after sending one or more vectors. A pointer to a function that is called whenever all vectors (samples) of a set of samples have been transferred in acquiry mode. This notification can be used for painting vectors when no vectors are coming in.
|
|
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 for each vector. A pointer to a function that is called for every significant vector (sample) received from the tablet in acquiry mode. Use SPTabletSetFlags to define behaviour for vectors having a pressure value of 0. Coordinates are sent in tablet coordinates. It is the application's responsibility to convert coordinates into user coordinate space. Tablet coordinates are by default normalized to a resolution of 300 DPI. The coordinate origin is the top left corner of the display window, or the lower left corner of the screen (converted to tablet coordinates) when using an full screen LCD tablet.
Coordinate space: 0, 0 equals top left corner. The bottom right corner is calculated phys. height * resolution / 25.4, and phys width * resolution / 25.5, where resolution equals the value returned by SPTabletGetReolution.
|
|
Callback function that is called when vectors are available. A pointer to a function that is called whenever a new set of vectors (samples) is available from the tablet in acquiry mode. The function is called before the vectors of that set are sent to the application.
|
|
Callback function that is called when a hardware button is pressed on the tablet. 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 the status of a tablet changes, please read tablet status change notifications for more details. A pointer to a function that is called to notify the application about a hardware events.
|
Function Documentation
|
Put an SPTablet object into acquiry mode.
This function enables acquiry mode and sends all vectors (samples) from the tablet to the registered listener. If SP_ACQUIRE_TRANSFER_0_VECTORS is set, all vectors having a pressure value of 0 will be sent; if SP_ACQUIRE_TRANSFER_0_VECTORS is not set, only one vector having a pressure value of 0 will be sent for a sequence of vectors having a pressure level of 0. This function will return immediately if SP_ACQUIRE_RETURN_IMMEDIATELY is set. If SP_ACQUIRE_RETURN_IMMEDIATELY is not set, this function will block until SPTabletAcquireDone is called.
|
|
Terminate acquiry mode of an SPTablet object.
This function terminates acquiry mode, the device state changes to the connect state (see SPTabletGetState).
|
|
Clear the background image of an SPTablet object. The tablet used by the SPTablet object must have an LCD.
Not all tablets support displaying idle images; currently only Wacom SignPad tablets support a background image that will be displayed in idle mode (more precise whenever the application disconnects the device (SPTabletDisconnect)).
|
|
Connect an SPTablet object to a tablet.
This function establishes a connection to a tablet. The state changes from idle to connect (see SPTabletGetState)
|
|
Create a new SPTablet object. This function checks if the requested driver can be loaded and if a device for this driver can be found. All device-specific information will be available, if a device is found. Call SPTabletGetDevice to get the identifier of the device that was detected. Please read Tablet creation options
|
|
Create a new SPTablet object based on an Alias. Please read Tablet creation options for resolving the Alias
|
|
Create a new SPTablet object. Please read Tablet creation options for a list of supported options
|
|
Create a new SPTablet object. Please read Tablet creation options for a list of supported options
|
|
Disconnect a tablet from an SPTablet object.
This function terminates a connection to a tablet. The state changes from connect to idle (see SPTabletGetState)
|
|
Deallocate an SPTablet object. The SPTablet object must have been allocated with SPTabletCreate or SPTabletCreateEx.
|
|
Get the device ID of an SPTablet object. Wacom drivers do not pass information about the connected devices, the detected device may differ from the physically connected tablet. SPTablet uses the size of the device to identify the connected model.
|
|
Get the name of the tablet device.
The buffer should have a size of at least 256 bytes.
|
|
Query the display type of the tablet used by this SPTablet object. SPTablet differentiates 3 types of tablet displays
|
|
Get the driver ID of an SPTablet object.
|
|
Get the name of a tablet driver.
The buffer should have a size of at least 256 bytes.
|
|
Get the tablet flags for acquiry mode of an SPTablet object. By default, the flags are set to SP_ACQUIRE_RETURN_IMMEDIATELY, that is:
|
|
Get the hardware file name of an SPTablet object.
The hardware file name equals the name that was used to connect to the device. Serial Connections use "\\.\COMi" (i equals the COM port number), USB file names are composed of the device id, manufacturer id like "\\?\hid#vid_056a&pid_00a1#6&37604930&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030}".
|
|
Check if the tablet used by an SPTablet object is a full-screen tablet. This function checks for tablets which are integrated into the PC screen. Tablets identified by these tablet ID's are full-screen tablets: SPTablet differentiates 3 types of tablets
|
|
Get the bit depth of the LCD of the tablet. The currently supported tabletts with external LCD have 1 bit per pixel, black/white screens.
|
|
Get the offset of the LCD of the tablet used by an SPTablet object.
The offset is typically 0, however full screeen devices may be operated in multi monitor configurations, that may result in a screen offset.
|
|
Get the size of the LCD of the tablet used by an SPTablet object.
|
|
Get the pressure range of an SPTablet object. The maximum pressure value is read from the capabilities of the tablet used by the SPTablet object. The pressure values of the signature data are normalized to the range 0 through 1023.
|
|
Get the tablet serial ID of an SPTablet object. The size of a tablet serial ID is limited to 20 bytes within the SignWare data structures, more limitations may apply depending on the tablet. Tablets that support serial ID's:
|
|
Get the tablet size of an SPTablet object.
|
|
Get the logical resolution of an SPTablet object. By default, the resolution is set to 300 DPI. Tablets have a resolution defined by the physical resolution in the tablet hardware. The SPTablet implementation 'resamples' the vectors and transforms each vector to the given resolution. The absolute position of the pen is calculated by the tablet coordinate * 25.4 / iResolution.
|
|
Get the resolution of an SPTablet object. By default, the resolution is set to 300 DPI. Tablets have a resolution defined by the physical resolution in the tablet hardware. The SPTablet implementation 'resamples' the vectors and transforms each vector to the given resolution. The absolute position of the pen is calculated by the tablet coordinate * 25.4 / iResolution.
|
|
Get the logical sample rate of an SPTablet object. Query the sample rate of the tablet. Some tablets allow to set the sample rate below the maximum physical sample rate
|
|
Get the sample rate of an SPTablet object. Query the sample rate of the tablet. Some tablets allow to set the sample rate below the maximum physical sample rate
|
|
Get the state of an SPTablet object.
|
|
Get the tablet size of an SPTablet object. To convert from tablet coordinates to mm, use this formula: tablet_size_mm = tablet_coordinate / (SPTabletGetResolution(pTablet) * 25.4)
|
|
Query the tablet type. The tablet size is set during initialization and cannot be overwritten. The tablet type defines some special behaviour of e. g. standalone tablets. The application should display a wait indicator instead of the realtime signature strokes, if SP_TABLET_NO_REALTIME_VECTORS is set. The application should register a hardware button listener to process virtual buttons, if SP_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS is set, see pSPTABLETBUTTON_T.
|
|
Get the timestamp of the signature. most recently acquired by an SPTablet object. The timestamp can be retrieved after calling SPTabletAcquire until SPTabletDisconnect is called.
|
|
Get the optional user parameter of an SPTablet object.
|
|
Check if the tablet used by an SPTablet object has an integrated LCD. This function checks for tablets with a built-in LCD. Full-screen tablets (capture devices integrated into the PC screen) are not considered to be tablets having an integrated LCD. Tablets identified by these tablet ID's have an integrated LCD:
SPTablet differentiates 3 types of tablets
|
|
Get the proximity capability of an SPTablet object. Devices that do not support proximity don't send the current pen position as long as the pen is up. Special care must therefore be taken when drawing the first vector (sample) having a non-zero pressure value. The SPTablet object will insert a vector having a pressure value of 0 and the coordinates of the first vector having a non-zero pressure value to inform all listeners on the current pen position for these devices. These tablets support proximity:
|
|
Reload the tablet characteristics. Tablet characteristics are typically bound to the hardware and do not change, except for TabletPCs where the screen resolution or screen orientation might change. Both screen resolution and orientation must be considered to calculate the physical tablet width / height and tablet LCD width and height. Applications that support display resolution or orientation changes while acquiring a signature should call SPTabletReloadParameters while or after processing the WM_DISPLAYCHANGE message, see example below.
|
|
Reset all tablet drivers. This will unload all tablet drivers and reset the internal states to "unconnected". The next request for a tablet operation will reload the drivers.
|
|
Set the background image of an SPTablet object. The tablet used by the SPTablet object must have an LCD. The image will be converted to the format required by the tablet. This includes size and color-depth conversions, however the conversion may be lossy. It is therefore recommended to create the image using the size and color depth of the tablet LCD and in a format that is directly supported by the device.
|
|
Set the background image of an SPTablet object. The tablet used by the SPTablet object must have an LCD. The image will be converted to the format required by the tablet. This includes size and color-depth conversions, however the conversion may be lossy. It is therefore recommended to create the image using the size and color depth of the tablet LCD and in a format that is directly supported by the device.
Not all tablets support displaying idle images; currently only Wacom SignPad tablets support a background image that will be displayed in idle mode (more precise whenever the application disconnects the device (SPTabletDisconnect)).
|
|
Set the hardware button listener of an SPTablet object.
|
|
Set the clipping rectangle for the tablet display.
Strokes outside the clipping rectangle will not be drawn on the tablet screen.
|
|
Set the device ID of an SPTablet object. The device ID is set during initialization and should not be overwritten unless you know what you do.
|
|
Set the display type of the tablet used by this SPTablet object. SPTablet differentiates 3 types of tablet displays
|
|
Set the driver ID of an SPTablet object. The driver ID is set during initialization and should not be overwritten unless you know what you do.
|
|
Set the tablet flags for acquiry mode of an SPTablet object.
|
|
Change an SPTablet object's notion of the presence of a full-screen tablet. The tablet's LCD capability is determined during initialization and should not be overwritten unless you know what you do.
|
|
Set listeners of an SPTablet object. The SPTablet object calls the listener that was registered last. Call SPTabletSetListener(0, 0, 0) to deregister any listeners.
|
|
Set listeners of an SPTablet object. The SPTablet object calls the listener that was registered last. Call SPTabletSetListener(0, 0, 0) to deregister any listeners.
|
|
Set the pressure range of an SPTablet object. The maximum pressure value is set during initialization and should not be overwritten unless you know what you do.
|
|
Set the tablet serial ID of an SPTablet object. The size of a tablet serial ID is limited to 20 bytes within the SignWare data structures, more limitations may apply depending on the tablet. Tablets that support serial ID's:
|
|
Set the resolution of an SPTablet object. The resolution is set during initialization and should not be overwritten unless you know what you do. Tablets have a resolution defined by the physical resolution in the tablet hardware. The SPTablet implementation 'resamples' the vectors and transforms each vector to the given resolution. The absolute position of the pen is calculated by the tablet coordinate * 25.4 / iResolution.
|
|
Set the sample rate of an SPTablet object. The sample rate is set during initialization and should not be overwritten unless you know what you do.
|
|
Set the hardware status listener of an SPTablet object.
|
|
Set a tablet parameter. Options can only be passed to the tablet when the tablet is in state SP_TABLET_STATE_CONNECT.
|
|
Set the tablet size of an SPTablet object. The tablet size is set during initialization and should not be overwritten unless you know what you do.
|
|
Pass a license ticket for the next signature capture(s). When using the ticket license model, you must pass the ticket before you connect with the tablet. This function copies the SPTicket object. The ticket must be charged for usage SP_TICKET_CAPTURE.
|
|
Set the optional user parameter of an SPTablet object. The optional user parameter is not used inside SignWare, you may add one additional void pointer parameter for application purposes.
|
|
Chooses a different type of serial ID to be returned by SPTabletGetSerial.
|