visit Kofax web site

SPGuiDyn.h File Reference


Detailed Description

SignWare Dynamic Development toolkit, display dynamic features in a signature.

Author:
uko
An SPGuiDyn object creates a client window and displays the dynamic features of the signature within this client window. It supports Standard window properties.
The functions declared in this header are not yet implemented for Linux.

Note:
Dynamic parameters are used internally as an input to the dynamic compare engine. The parameters are visualized for test and demonstration purposes only, the values proper are not available to applications.

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
"PenThickness" 127 1 ... 255 Pen thickness, 1 thin, 255 bold pen
"ScrBorder" 5 0 ... 255 Size of the border in pixel
"XColor" dark red Color for x-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"YColor" dark green Color for y-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"PColor" dark blue Color for p-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"DXColor" light red Color for dx-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"DYColor" light green Color for dy-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"DPColor" light blue Color for dp-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"SpeedColor" yellow Color for speed-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"DDXColor" pink Color for ddx-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"DDYColor" brown Color for ddy-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"AccelColor" gray Color for accel-curve, format 0xrrggbb, rr: red, gg: green, bb: blue
"EraseBackground" false SPBOOL erase the background, see SP_ERASE_BACKGROUND for details
"WindowBorder" false SPBOOL Draw a border around the window, see SP_DRAW_HWND_BORDER for details
"JavaDrawInPanel" false SPBOOL only Java: the application also paints in the panel which hosts the SPGuiDyn object


Defines

#define SP_DRAW_ACCEL   0x02000000
 Draw the acceleration curve (for SPGuiDyn).
#define SP_DRAW_DDX   0x00800000
 Draw the X'' curve (for SPGuiDyn).
#define SP_DRAW_DDY   0x01000000
 Draw the Y'' curve (for SPGuiDyn).
#define SP_DRAW_DP   0x00200000
 Draw the P' curve (for SPGuiDyn).
#define SP_DRAW_DX   0x00080000
 Draw the X' curve (for SPGuiDyn).
#define SP_DRAW_DY   0x00100000
 Draw the Y' curve (for SPGuiDyn).
#define SP_DRAW_P   0x00040000
 Draw the P curve (for SPGuiDyn).
#define SP_DRAW_SPEED   0x00400000
 Draw the speed curve (for SPGuiDyn).
#define SP_DRAW_X   0x00010000
 Draw the X curve (for SPGuiDyn).
#define SP_DRAW_Y   0x00020000
 Draw the Y curve (for SPGuiDyn).

Functions

SPINT32 __cdecl SPGuiDynCreate (pSPGUIDYN_T *ppSPGuiDyn, SPHWND hwndParent)
 Create an SPGuiDyn object (window).
SPINT32 __cdecl SPGuiDynCreateInClient (pSPGUIDYN_T *ppSPGuiDyn, SPHWND hwndClient, SPHWND hwndParent)
 Create an SPGuiDyn object embedded in a client window.
SPINT32 __cdecl SPGuiDynFree (pSPGUIDYN_T *ppSPGuiDyn)
 Deallocate all resources used by an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynGetBoolProperty (pSPGUIDYN_T pSPGuiDyn, const SPCHAR *pszName, SPBOOL *pbValue)
 Set a property.
SPINT32 SPGuiDynGetBorder (pSPGUIDYN_T pSPGuiDyn, SPINT32 *piBorder)
 Get the size of the border of an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynGetDrawMode (pSPGUIDYN_T pSPGuiDyn, SPINT32 *piDrawMode)
 Get the draw mode of an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynGetHwnd (pSPGUIDYN_T pSPGuiDyn, SPHWND *pHwnd)
 Get the window handle of the window associated with an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynGetIntProperty (pSPGUIDYN_T pSPGuiDyn, const SPCHAR *pszName, SPINT32 *piValue)
 Set a property.
SPINT32 __cdecl SPGuiDynGetSignature (pSPGUIDYN_T pSPGuiDyn, pSPSIGNATURE_T *ppSignature)
 Query the signature in an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynNew (pSPGUIDYN_T *ppSPGuiDyn)
 Create an SPGuiDyn object (window).
SPINT32 __cdecl SPGuiDynSetBoolProperty (pSPGUIDYN_T pSPGuiDyn, const SPCHAR *pszName, SPBOOL bValue)
 Set a property.
SPINT32 SPGuiDynSetBorder (pSPGUIDYN_T pSPGuiDyn, SPINT32 iBorder)
 Set the size of the border of an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynSetClient (pSPGUIDYN_T pSPGuiDyn, SPHWND hwndClient, SPHWND hwndParent)
 Create the visual components of a SPGuiDyn object embedded in a client window.
SPINT32 __cdecl SPGuiDynSetDrawMode (pSPGUIDYN_T pSPGuiDyn, SPINT32 iDrawMode)
 Set the draw mode of an SPGuiDyn object.
SPINT32 __cdecl SPGuiDynSetIntProperty (pSPGUIDYN_T pSPGuiDyn, const SPCHAR *pszName, SPINT32 iValue)
 Set a property.
SPINT32 __cdecl SPGuiDynSetSignature (pSPGUIDYN_T pSPGuiDyn, pSPSIGNATURE_T pSignature)
 Set the signature to be displayed by an SPGuiDyn object.


Define Documentation

#define SP_DRAW_ACCEL   0x02000000
 

Draw the acceleration curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_DDX   0x00800000
 

Draw the X'' curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_DDY   0x01000000
 

Draw the Y'' curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_DP   0x00200000
 

Draw the P' curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_DX   0x00080000
 

Draw the X' curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_DY   0x00100000
 

Draw the Y' curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_P   0x00040000
 

Draw the P curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_SPEED   0x00400000
 

Draw the speed curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_X   0x00010000
 

Draw the X curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode

#define SP_DRAW_Y   0x00020000
 

Draw the Y curve (for SPGuiDyn).

See also:
SPGuiDynSetDrawMode


Function Documentation

SPINT32 __cdecl SPGuiDynCreate pSPGUIDYN_T ppSPGuiDyn,
SPHWND  hwndParent
 

Create an SPGuiDyn object (window).

Parameters:
ppSPGuiDyn [o] pointer to a variable that will be filled with a pointer to the new SPGuiDyn object. The caller is responsible for deallocating the new object by calling SPGuiDynFree.
hwndParent [i] window handle of the parent window.
Returns:
SP_NOERR on success, else error code:
See also:
SPGuiDynCreateInClient, SPGuiDynFree
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynCreateInClient pSPGUIDYN_T ppSPGuiDyn,
SPHWND  hwndClient,
SPHWND  hwndParent
 

Create an SPGuiDyn object embedded in a client window.

Parameters:
ppSPGuiDyn [o] pointer to a variable that will be filled with a pointer to the new SPGuiDyn object. The caller is responsible for deallocating the new object by calling SPGuiDynFree.
hwndClient [i] window handle of the window that will be subclassed to add the SPGuiDyn functionality.
hwndParent [i] window handle of the parent window.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynCreate, SPGuiDynFree
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynFree pSPGUIDYN_T ppSPGuiDyn  ) 
 

Deallocate all resources used by an SPGuiDyn object.

The SPGuiDyn object must have been created by SPGuiDynCreate or SPGuiDynCreateInClient.

Parameters:
ppSPGuiDyn [io] pointer to a variable containing a pointer to an SPGuiDyn object. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynCreate, SPGuiDynCreateInClient
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynGetBoolProperty pSPGUIDYN_T  pSPGuiDyn,
const SPCHAR pszName,
SPBOOL pbValue
 

Set a property.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
pszName [i] Name of the property, see SPGuiDyn Properties
pbValue [i] pointer to avariable that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Todo:
Implement for Linux

SPINT32 SPGuiDynGetBorder pSPGUIDYN_T  pSPGuiDyn,
SPINT32 piBorder
 

Get the size of the border of an SPGuiDyn object.

By default, the border size is 5 pixels.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
piBorder [o] pointer to a variable that will be filled with the border size (in screen pixels).
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetBorder
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynGetDrawMode pSPGUIDYN_T  pSPGuiDyn,
SPINT32 piDrawMode
 

Get the draw mode of an SPGuiDyn object.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
piDrawMode [i] pointer to a variable that will be filled with the draw mode which is a combination of these values:
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetDrawMode
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynGetHwnd pSPGUIDYN_T  pSPGuiDyn,
SPHWND pHwnd
 

Get the window handle of the window associated with an SPGuiDyn object.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
pHwnd [o] pointer to a variable that will be filled with the window handle that is associated with the SPGuiDyn object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynCreate, SPGuiDynCreateInClient
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynGetIntProperty pSPGUIDYN_T  pSPGuiDyn,
const SPCHAR pszName,
SPINT32 piValue
 

Set a property.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
pszName [i] Name of the property, see SPGuiDyn Properties
piValue [i] pointer to avariable that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynGetSignature pSPGUIDYN_T  pSPGuiDyn,
pSPSIGNATURE_T ppSignature
 

Query the signature in an SPGuiDyn object.

This function returns a copy of the signature; modifying the SPSignature object after calling this function won't have an effect on the SPGuiDisp object.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
ppSignature [i] pointer to an SPSignature object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetSignature
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynNew pSPGUIDYN_T ppSPGuiDyn  ) 
 

Create an SPGuiDyn object (window).

SPGuiDynNew creates the native object, but does not instantiate any visual components.
Call SPGuiDynSetClient to create the visual components.

Note:
The calling sequence SPGuiDynNew and SPGuiDynSetClient equals the call SPGuiDynCreate or SPGuiDynCreateInClient
Parameters:
ppSPGuiDyn [o] pointer to a variable that will be filled with a pointer to the new SPGuiDyn object. The caller is responsible for deallocating the new object by calling SPGuiDynFree.
Returns:
SP_NOERR on success, else error code:
See also:
SPGuiDynSetClient, SPGuiDynFree
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynSetBoolProperty pSPGUIDYN_T  pSPGuiDyn,
const SPCHAR pszName,
SPBOOL  bValue
 

Set a property.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
pszName [i] Name of the property, see SPGuiDyn Properties
bValue [i] the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Todo:
Implement for Linux

SPINT32 SPGuiDynSetBorder pSPGUIDYN_T  pSPGuiDyn,
SPINT32  iBorder
 

Set the size of the border of an SPGuiDyn object.

By default, the border size is 5 pixels.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
iBorder [i] the new border size (in screen pixels).
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynGetBorder
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynSetClient pSPGUIDYN_T  pSPGuiDyn,
SPHWND  hwndClient,
SPHWND  hwndParent
 

Create the visual components of a SPGuiDyn object embedded in a client window.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
hwndClient [i] window handle of the window that will be subclassed to add the SPGuiDyn functionality, may be NULL.
hwndParent [i] window handle of the parent window.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynNew, SPGuiDynFree
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynSetDrawMode pSPGUIDYN_T  pSPGuiDyn,
SPINT32  iDrawMode
 

Set the draw mode of an SPGuiDyn object.

By default, the draw mode is

Flags SP_DRAW_HWND_BORDER and SP_ERASE_BACKGROUND are always copied from iDrawMode.

If any flag of SP_DRAW_X, SP_DRAW_Y, SP_DRAW_P, SP_DRAW_DX, SP_DRAW_DY, SP_DRAW_DP, SP_DRAW_SPEED, SP_DRAW_DDX, SP_DRAW_DDY, or SP_DRAW_ACCEL is set in iDrawMode, all of these flags are copied from iDrawMode to the SPGuiDyn object. If none of these flags is set in iDrawMode, the SPGuiDyn object's current state of these flags will be retained.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
iDrawMode [i] the new draw mode, a combination of these values (but see above for what flags are affected under what circumstances):
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynGetDrawMode
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynSetIntProperty pSPGUIDYN_T  pSPGuiDyn,
const SPCHAR pszName,
SPINT32  iValue
 

Set a property.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
pszName [i] Name of the property, see SPGuiDyn Properties
iValue [i] the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Todo:
Implement for Linux

SPINT32 __cdecl SPGuiDynSetSignature pSPGUIDYN_T  pSPGuiDyn,
pSPSIGNATURE_T  pSignature
 

Set the signature to be displayed by an SPGuiDyn object.

This function makes a copy of the signature; modifying the SPSignature object after calling this function won't have an effect on the SPGuiDisp object.

Parameters:
pSPGuiDyn [i] pointer to an SPGuiDyn object.
pSignature [i] pointer to an SPSignature object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiDynCGetSignature
Todo:
Implement for Linux