visit Kofax web site

SPGuiContainer.h File Reference

Detailed Description

SignWare Dynamic Development toolkit, container for SPGui-Objects.

Author:
uko
This header includes a container to visualize multiple capturing signature capture objects.

The functions declared in this header are not yet implemented for Linux.

SPGuiContainer

The container may hold one or more SignWare Gui (SPGuiAcqu or SPGuiDisp) objects. The container includes a layout manager to display the objects horizontally tiled, vertically tiled or stacked.

Access to the contained objects is granted, however the container returns references to the objects rather than copies. This means that the application must not free object references.

Callbacks / event notifications are normally redirected from the capture object to the container, and then to the application.
Callbacks are called from the windows message event thread for the associated native window handle.
Do not free the SPContainer object within a callback method.

If the application registers notifications directly in the SPGuiAcqu object then the container will not be called but the application is directly called from the SPGuiAcqu event handlers.

If the application should be called from SPGuiContainer event handling then


SPGuiContainer uses indices to address the contained objects. However the indices may change when removing objects (SPGuiContainerObjectFree). The container inherits an object property "ObjectId", the application may use this property to identify each object.


SPGuiContainer uses Windows messages to synchronize communication from several threads. The message id range from WM_USER + 0x7BA0 (0x7FA0) to WM_USER + 0x7BAF (0x7FAF), please assure that the application does not conflict with the above message Id's.

Supported properties

The table below lists all supported Properties.

Name Default Range Description
"BackgroundColor" 0xFFFFFF SPINT32 Background color, format 0xrrggbb, rr: red, gg: green, bb: blue
"RectangleColor" 0x000000 SPINT32 Frame color, format 0xrrggbb, rr: red, gg: green, bb: blue
"ScrBorder" 5 0 ... 255 Size of the border in pixel
"WindowBorder" false SPBOOL Draw a border around the window
"EraseBackground" false SPBOOL Erase the background of the window
"Layout" SPGUICONTAINER_TILED_VERT SPINT32 Define the layout
"JavaDrawInPanel" false SPBOOL only Java: the application also paints in the panel which hosts the SPGuiContainer object


Defines

#define SPGUICONTAINER_GUIACQU   1
#define SPGUICONTAINER_GUIDISP   2
#define SPGUICONTAINER_GUIDYN   3
#define SPGUICONTAINER_STACKED   3
#define SPGUICONTAINER_TILED_HORZ   1
#define SPGUICONTAINER_TILED_VERT   2

Typedefs

typedef int(_cdecl * pSPGUICONTAINERBUTTONLISTENER_T )(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, SPINT32 iButtonId, SPINT32 iPress)
 Callback function that is called when a hardware button is pressed on the tablet.
typedef int(_cdecl * pSPGUICONTAINERLINETOLISTENER_T )(pSPGUICONTAINER_T pSpGuiContainer, SPINT32 iIndex, SPINT32 iX, SPINT32 iY, SPINT32 iPress, SPINT32 iTime)
 Callback function that is called for each vector.
typedef int(_cdecl * pSPGUICONTAINEROBJRECTLISTENER_T )(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, SPUINT32 uDocumentId, SPUINT32 uRectId)
 Callback function that is called when a virtual button (registered rectangle) is 'clicked' which is assignedto a ocument.
typedef int(_cdecl * pSPGUICONTAINERRECTLISTENER_T )(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, SPUINT32 uId)
 Callback function that is called when a virtual button (registered rectangle) is 'clicked'.
typedef int(_cdecl * pSPGUICONTAINERSTATUSLISTENER_T )(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, 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 * pSPGUICONTAINERTIMEOUTLISTENER_T )(pSPGUICONTAINER_T spContainer, int iIndex)
 Callback function that is called when a timeout occurs.

Functions

SPINT32 __cdecl SPGuiContainerAddObject (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iObjectType)
 Create an SPGui object in the SPGuiContainer.
SPINT32 __cdecl SPGuiContainerCreate (pSPGUICONTAINER_T *ppSPGuiContainer)
 Create an SPGuiContainer.
SPINT32 __cdecl SPGuiContainerCreateObject (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iIndex, SPINT32 iObjectType)
 Create an SPGui object in the SPGuiContainer.
SPINT32 __cdecl SPGuiContainerFree (pSPGUICONTAINER_T *ppSPGuiContainer)
 Free an SPGuiContainer.
SPINT32 __cdecl SPGuiContainerFreeObject (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iIndex)
 Free an SPGui object in the SPGuiContainer.
SPINT32 __cdecl SPGuiContainerGetBoolProperty (pSPGUICONTAINER_T pSPGuiContainer, const SPCHAR *pszName, SPBOOL *pbValue)
 Query a property.
SPINT32 __cdecl SPGuiContainerGetHwnd (pSPGUICONTAINER_T pSPGuiContainer, SPHWND *pHwnd)
 Get the window handle of the window associated with an SPGuiContainer object.
SPINT32 __cdecl SPGuiContainerGetIntProperty (pSPGUICONTAINER_T pSPGuiContainer, const SPCHAR *pszName, SPINT32 *piValue)
 Query a property.
SPINT32 __cdecl SPGuiContainerGetNumberObjects (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 *piNumberObjects)
 Query the number of objects in this container.
SPINT32 __cdecl SPGuiContainerGetObject (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iIndex, SPVPTR *ppObject, SPINT32 *piObjectType)
 Query an SPGui object in the SPGuiContainer.
SPINT32 __cdecl SPGuiContainerGetUserLong (pSPGUICONTAINER_T pSPGuiContainer, SPVPTR *pUser)
 Get a long variable in SPGuiContainer.
SPINT32 __cdecl SPGuiContainerObjectGetHwnd (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iIndex, SPHWND *pHwnd)
 Query the native window handle of an object embedded in SPGuiContainer.
SPINT32 __cdecl SPGuiContainerObjectGetType (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iIndex, SPINT32 *piType)
 Query the type of an object embedded in SPGuiContainer.
SPINT32 __cdecl SPGuiContainerSetActive (pSPGUICONTAINER_T pSPGuiContainer, SPINT32 iIndex)
 Set the active object embedded in SPGuiContainer.
SPINT32 __cdecl SPGuiContainerSetBoolProperty (pSPGUICONTAINER_T pSPGuiContainer, const SPCHAR *pszName, SPBOOL bValue)
 Set a property.
SPINT32 __cdecl SPGuiContainerSetClient (pSPGUICONTAINER_T pSPGuiContainer, SPHWND hChild, SPHWND hParent)
 Create the visible components of a SPGuiContainer object.
SPINT32 __cdecl SPGuiContainerSetDocumentListener (pSPGUICONTAINER_T pSpGuiContainer, pSPGUICONTAINEROBJRECTLISTENER_T pDocumentCallback)
 Set a vector listener in this object.
SPINT32 __cdecl SPGuiContainerSetIntProperty (pSPGUICONTAINER_T pSPGuiContainer, const SPCHAR *pszName, SPINT32 iValue)
 Set a property.
SPINT32 __cdecl SPGuiContainerSetListener (pSPGUICONTAINER_T pSPGuiContainer, pSPGUICONTAINERTIMEOUTLISTENER_T aTimeoutCallback, pSPGUICONTAINERSTATUSLISTENER_T aStatusCallback, pSPGUICONTAINERRECTLISTENER_T aRectCallback, pSPGUICONTAINERBUTTONLISTENER_T aButtonCallback)
 Register event listeners in this container.
SPINT32 __cdecl SPGuiContainerSetUserLong (pSPGUICONTAINER_T pSPGuiContainer, SPVPTR pUser)
 Set a long variable in SPGuiContainer.
SPINT32 __cdecl SPGuiContainerSetVectorListener (pSPGUICONTAINER_T pSpGuiContainer, pSPGUICONTAINERLINETOLISTENER_T pVectorCallback)
 Set a vector listener in this object.

Define Documentation

#define SPGUICONTAINER_GUIACQU   1
 

Type identifyer for a SPGuiAcqu object (pSPGUIACQU_T)

#define SPGUICONTAINER_GUIDISP   2
 

Type identifyer for a SPGuiDisp object (pSPGUIDISP_T)

#define SPGUICONTAINER_GUIDYN   3
 

Type identifyer for a SPGuiDyn object (pSPGUIDYN_T)

#define SPGUICONTAINER_STACKED   3
 

Type identifyer for stacked layout

#define SPGUICONTAINER_TILED_HORZ   1
 

Type identifyer for horizontally tiled layout

#define SPGUICONTAINER_TILED_VERT   2
 

Type identifyer for vertically tiled layout

Typedef Documentation

typedef int( _cdecl * pSPGUICONTAINERBUTTONLISTENER_T)(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, SPINT32 iButtonId, SPINT32 iPress)
 

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 tablet button being pressed during acquiry mode.

Parameters:
spContainer [i] pointer to the associated SPGuiContainer object
iIndex [i] zero based index of the object in the container which triggered the event
iButtonId [i] a value identifying the button that was pressed. The value depends on the tablet, see Tablet Hardware button Assignment
iPress [i] the value depends on the tablet, see Tablet Hardware button Assignment.
See also:
SPGuiContainerSetListener
Returns:
SP_NOERR on success, else error code, error codes are not evaluated

typedef int( _cdecl * pSPGUICONTAINERLINETOLISTENER_T)(pSPGUICONTAINER_T pSpGuiContainer, SPINT32 iIndex, SPINT32 iX, SPINT32 iY, SPINT32 iPress, SPINT32 iTime)
 

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.

Note:
SPGuiContainer handles all vectors internally, typically an application does not handle vectors.
Parameters:
pSpGuiContainer [i] pointer to the SPGuiContainer object that generated the event.
iIndex [i] zero based index of the object in the container which triggered the event
iX [i] the X coordinate (in tablet coordinates) of the vector.
iY [i] the Y coordinate (in tablet coordinates) of the vector.
iPress [i] the pressure value of the vector, normalized to 0 through 1023.
iTime [i] the time value of the vector, may be -1 if the time is not measured.
Returns:
always SP_NOERR, currently ignored.
See also:
SPGuiContainerSetVectorListener

typedef int( _cdecl * pSPGUICONTAINEROBJRECTLISTENER_T)(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, SPUINT32 uDocumentId, SPUINT32 uRectId)
 

Callback function that is called when a virtual button (registered rectangle) is 'clicked' which is assignedto a ocument.

Parameters:
spContainer [i] pointer to the associated SPGuiContainer object
iIndex [i] zero based index of the object in the container which triggered the event
uDocumentId [i] the identifier of the document.
uRectId [i] the identifier of the rectangle that was clicked.
Returns:
SP_NOERR on success, else error code, error codes are not evaluated
See also:
SPGuiContainerSetListener

SPGuiAcquRegisterRect, SPGuiAcquRegisterRect2

typedef int( _cdecl * pSPGUICONTAINERRECTLISTENER_T)(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, SPUINT32 uId)
 

Callback function that is called when a virtual button (registered rectangle) is 'clicked'.

Parameters:
spContainer [i] pointer to the associated SPGuiContainer object
iIndex [i] zero based index of the object in the container which triggered the event
uId [i] the identifier of the rectangle that was clicked.
Returns:
SP_NOERR on success, else error code, error codes are not evaluated
See also:
SPGuiContainerSetListener

SPGuiAcquRegisterRect, SPGuiAcquRegisterRect2

typedef int( _cdecl * pSPGUICONTAINERSTATUSLISTENER_T)(pSPGUICONTAINER_T spContainer, SPINT32 iIndex, int iMajor, int iDetail)
 

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.

Parameters:
spContainer [i] pointer to the associated SPGuiContainer object
iIndex [i] zero based index of the object in the container which triggered the event
iMajor [i] major event description
iDetail detail event description
Returns:
SP_NOERR on success, else error code, error codes are not evaluated
See also:
SPGuiContainerSetListener

typedef int( _cdecl * pSPGUICONTAINERTIMEOUTLISTENER_T)(pSPGUICONTAINER_T spContainer, int iIndex)
 

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.

Parameters:
spContainer [i] pointer to the associated SPGuiContainer object
iIndex [i] zero based index of the object in the container which triggered the event
Returns:
SP_NOERR on success, else error code, error codes are not evaluated
See also:
SPGuiAcquSetTimeout2

SPGuiContainerSetListener

Function Documentation

SPINT32 __cdecl SPGuiContainerAddObject (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iObjectType
) 
 

Create an SPGui object in the SPGuiContainer.

Create a Signware GUI object and insert it at the last position of the containers object list.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iObjectType [i] the object type to create
  • SPGUICONTAINER_GUIACQU create a SPGuiAcqu object
  • SPGUICONTAINER_GUIDISP create a SPGuiDisp object
  • SPGUICONTAINER_GUIDYN create a SPGuiDyn object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerCreateObject, SPGuiContainerFreeObject, SPGuiContainerGetObject, SPGuiContainerGetNumberObjects

SPINT32 __cdecl SPGuiContainerCreate (  pSPGUICONTAINER_T *  ppSPGuiContainer  ) 
 

Create an SPGuiContainer.

SPGuiContainerCreate creates the native object without visual components. Call SPGuiContainerSetClient to create the visual components.

Parameters:
ppSPGuiContainer [o] pointer to a variable that will be filled with a pointer to a new SPGuiContainer object. The caller is responsible for deallocating the new object by calling SPGuiContainerFree.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerSetClient, SPGuiContainerFree

SPINT32 __cdecl SPGuiContainerCreateObject (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iIndex,
SPINT32  iObjectType
) 
 

Create an SPGui object in the SPGuiContainer.

Create a Signware GUI object at the specified zero based index in the containers object list.

Note:
The object at the position iIndex will be destroyed.
Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iIndex [i] zero based index
iObjectType [i] the object type to create
  • SPGUICONTAINER_GUIACQU create a SPGuiAcqu object
  • SPGUICONTAINER_GUIDISP create a SPGuiDisp object
  • SPGUICONTAINER_GUIDYN create a SPGuiDyn object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerAddObject, SPGuiContainerFreeObject, SPGuiContainerGetObject, SPGuiContainerGetNumberObjects

SPINT32 __cdecl SPGuiContainerFree (  pSPGUICONTAINER_T *  ppSPGuiContainer  ) 
 

Free an SPGuiContainer.

Close the native window and free all associated resources.

Parameters:
ppSPGuiContainer [o] pointer to a variable that contains valid SPGuiContainer object. Will be set to NULL on success.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiConatinerCreate, SPGuiContainerSetClient

SPINT32 __cdecl SPGuiContainerFreeObject (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iIndex
) 
 

Free an SPGui object in the SPGuiContainer.

Destroy and release a Signware GUI object at the specified zero based index in the containers object list.

Note:
The object is removed from the container object list, this means the indices of all successive objects will change.
SPGuiContainer inherits the Property "ObjectId" when creating objects, the application may use the property "ObjectId" to keep track of objects in the container.
Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iIndex [i] zero based index
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerAddObject, SPGuiContainerCreateObject, SPGuiContainerGetObject, SPGuiContainerGetNumberObjects

SPINT32 __cdecl SPGuiContainerGetBoolProperty (  pSPGUICONTAINER_T  pSPGuiContainer,
const SPCHAR *  pszName,
SPBOOL *  pbValue
) 
 

Query a property.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
pszName [i] Name of the property, see SPGuiContainer Properties
pbValue [o] pointer to a variable that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPGuiContainerGetHwnd (  pSPGUICONTAINER_T  pSPGuiContainer,
SPHWND *  pHwnd
) 
 

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

For an SPGuiContainer object created with SPGuiContainerSetClient, this function returns the handle of the client window.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
pHwnd [o] pointer to a variable that will be filled with the window handle of the window associated with the SPGuiContainer object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerCreate, SPGuiContainerSetClient

SPINT32 __cdecl SPGuiContainerGetIntProperty (  pSPGUICONTAINER_T  pSPGuiContainer,
const SPCHAR *  pszName,
SPINT32 *  piValue
) 
 

Query a property.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
pszName [i] Name of the property, see SPGuiContainer Properties
piValue [o] pointer to a variable that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPGuiContainerGetNumberObjects (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32 *  piNumberObjects
) 
 

Query the number of objects in this container.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
piNumberObjects [o] pointer to an integer that will be filled with the number of objects in this container
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerAddObject, SPGuiContainerCreateObject, SPGuiContainerFreeObject, SPGuiContainerGetObject

SPINT32 __cdecl SPGuiContainerGetObject (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iIndex,
SPVPTR *  ppObject,
SPINT32 *  piObjectType
) 
 

Query an SPGui object in the SPGuiContainer.

Query a Signware GUI object at the specified zero based index in the containers object list.

Note:
the returned object is a reference to the SignWare SPGui object. Do not free or destroy the returned object.
Do not register any event listener in the returned object if events should be delegated via SPGuiContainer.
Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iIndex [i] zero based index
ppObject [o] pointer to object variable that will be filled with the object at the specified index
piObjectType [o] the object type
  • SPGUICONTAINER_GUIACQU a SPGuiAcqu object
  • SPGUICONTAINER_GUIDISP a SPGuiDisp object
  • SPGUICONTAINER_GUIDYN a SPGuiDisp object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerAddObject, SPGuiContainerCreateObject, SPGuiContainerFreeObject, SPGuiContainerGetNumberObjects

SPINT32 __cdecl SPGuiContainerGetUserLong (  pSPGUICONTAINER_T  pSPGuiContainer,
SPVPTR *  pUser
) 
 

Get a long variable in SPGuiContainer.

Note:
SPGuiContainer does no use this variable, it is intended for application usage.
Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
pUser [o] pointer to a variable that will be filled with the value in SPGuiContainer
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerSetUserLong

SPINT32 __cdecl SPGuiContainerObjectGetHwnd (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iIndex,
SPHWND *  pHwnd
) 
 

Query the native window handle of an object embedded in SPGuiContainer.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iIndex [i] zero based index
pHwnd [i] pointer to a variable that will be filled with the native window handle
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPGuiContainerObjectGetType (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iIndex,
SPINT32 *  piType
) 
 

Query the type of an object embedded in SPGuiContainer.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iIndex [i] zero based index
piType [o] pointer to a variable that will be filled with the object type:
  • SPGUICONTAINER_GUIACQU SPGuiAcqu object
  • SPGUICONTAINER_GUIDISP SPGuiDisp object
  • SPGUICONTAINER_GUIDYN SPGuiDyn object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPGuiContainerSetActive (  pSPGUICONTAINER_T  pSPGuiContainer,
SPINT32  iIndex
) 
 

Set the active object embedded in SPGuiContainer.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
iIndex [i] zero based index
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPGuiContainerSetBoolProperty (  pSPGUICONTAINER_T  pSPGuiContainer,
const SPCHAR *  pszName,
SPBOOL  bValue
) 
 

Set a property.

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

SPINT32 __cdecl SPGuiContainerSetClient (  pSPGUICONTAINER_T  pSPGuiContainer,
SPHWND  hChild,
SPHWND  hParent
) 
 

Create the visible components of a SPGuiContainer object.

If hChild is a valid window handle then SPGuiContainer subclasses the native window identified by hChild. It uses this window to draw the embedded objects.

If hChild is a not valid window handle then SPGuiContainer creates a native window.

Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
hChild [i] window handle of the child window to use, may be NULL.
hParent [i] window handle of the parent window.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiConatinerCreate, SPGuiContainerFree

SPINT32 __cdecl SPGuiContainerSetDocumentListener (  pSPGUICONTAINER_T  pSpGuiContainer,
pSPGUICONTAINEROBJRECTLISTENER_T  pDocumentCallback
) 
 

Set a vector listener in this object.

Note:
the application unregisters a listener when passing NULL for pVectorCallback
Parameters:
pSpGuiContainer [i] pointer to an SPGuiContainer object.
pDocumentCallback [i] function that is to be called when a virtual button, that i assigned to a document, was clicked.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPGuiContainerSetIntProperty (  pSPGUICONTAINER_T  pSPGuiContainer,
const SPCHAR *  pszName,
SPINT32  iValue
) 
 

Set a property.

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

SPINT32 __cdecl SPGuiContainerSetListener (  pSPGUICONTAINER_T  pSPGuiContainer,
pSPGUICONTAINERTIMEOUTLISTENER_T  aTimeoutCallback,
pSPGUICONTAINERSTATUSLISTENER_T  aStatusCallback,
pSPGUICONTAINERRECTLISTENER_T  aRectCallback,
pSPGUICONTAINERBUTTONLISTENER_T  aButtonCallback
) 
 

Register event listeners in this container.

Note:
the application unregisters a listener when passing NULL for the according listener callback method.
Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
aTimeoutCallback [i] listener that will be invoked if an object signals a timeout
aStatusCallback [i] listener that will be invoked if an object signals a status change
aRectCallback [i] listener that will be invoked if an object signals a virtual button click
aButtonCallback [i] listener that will be invoked if an object signals a (hardware) button click
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerAddObject, SPGuiContainerCreateObject, SPGuiContainerFreeObject, SPGuiContainerGetObject

SPINT32 __cdecl SPGuiContainerSetUserLong (  pSPGUICONTAINER_T  pSPGuiContainer,
SPVPTR  pUser
) 
 

Set a long variable in SPGuiContainer.

Note:
SPGuiContainer does no use this variable, it is intended for application usage.
Parameters:
pSPGuiContainer [i] pointer to an SPGuiContainer object.
pUser [i] the value to set
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPGuiContainerGetUserLong

SPINT32 __cdecl SPGuiContainerSetVectorListener (  pSPGUICONTAINER_T  pSpGuiContainer,
pSPGUICONTAINERLINETOLISTENER_T  pVectorCallback
) 
 

Set a vector listener in this object.

Note:
the application unregisters a listener when passing NULL for pVectorCallback
Parameters:
pSpGuiContainer [i] pointer to an SPGuiContainer object.
pVectorCallback [i] function that is to be called when a vector was captured.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)