wHiteRabbiT-sTudio Framework
wHiteRabbiT.Common.Wacom.CWintabData Class Reference

Class to support capture and management of Wintab daa. More...

Public Member Functions

 CWintabData (CWintabContext context_I)
 CWintabData constructor More...
 
bool SetPacketQueueSize (UInt32 numPkts_I)
 Set the handler to be called when WT_PACKET events are received. More...
 
UInt32 GetPacketQueueSize ()
 Get packet queue size for this data object's context. More...
 
WintabPacketExt GetDataPacketExt (UInt32 hCtx_I, UInt32 pktID_I)
 Returns one packet of WintabPacketExt data from the packet queue. More...
 
WintabPacket GetDataPacket (UInt32 pktID_I)
 Returns one packet of WintabPacket data from the packet queue. More...
 
WintabPacket GetDataPacket (UInt32 hCtx_I, UInt32 pktID_I)
 Returns one packet of Wintab data from the packet queue. More...
 
WintabPacket[] GetDataPackets (UInt32 maxPkts_I, bool remove_I, ref UInt32 numPkts_O)
 Returns an array of Wintab data packets from the packet queue. More...
 

Detailed Description

Class to support capture and management of Wintab daa.

Constructor & Destructor Documentation

wHiteRabbiT.Common.Wacom.CWintabData.CWintabData ( CWintabContext  context_I)

CWintabData constructor

Parameters
context_Ilogical context for this data object

Member Function Documentation

WintabPacket wHiteRabbiT.Common.Wacom.CWintabData.GetDataPacket ( UInt32  pktID_I)

Returns one packet of WintabPacket data from the packet queue.

(Deprecated)

Parameters
pktID_IIdentifier for the tablet event packet to return.
Returns
Returns a data packet with non-null context if successful.
WintabPacket wHiteRabbiT.Common.Wacom.CWintabData.GetDataPacket ( UInt32  hCtx_I,
UInt32  pktID_I 
)

Returns one packet of Wintab data from the packet queue.

Parameters
hCtx_IWintab context to be used when asking for the data
pktID_IIdentifier for the tablet event packet to return.
Returns
Returns a data packet with non-null context if successful.
WintabPacketExt wHiteRabbiT.Common.Wacom.CWintabData.GetDataPacketExt ( UInt32  hCtx_I,
UInt32  pktID_I 
)

Returns one packet of WintabPacketExt data from the packet queue.

Parameters
hCtx_IWintab context to be used when asking for the data
pktID_IIdentifier for the tablet event packet to return.
Returns
Returns a data packet with non-null context if successful.
WintabPacket [] wHiteRabbiT.Common.Wacom.CWintabData.GetDataPackets ( UInt32  maxPkts_I,
bool  remove_I,
ref UInt32  numPkts_O 
)

Returns an array of Wintab data packets from the packet queue.

Parameters
maxPkts_ISpecifies the maximum number of packets to return.
remove_IIf true, returns data packets and removes them from the queue.
numPkts_ONumber of packets actually returned.
Returns
Returns the next maxPkts_I from the list. Note that if remove_I is false, then repeated calls will return the same packets. If remove_I is true, then packets will be removed and subsequent calls will get different packets (if any).
UInt32 wHiteRabbiT.Common.Wacom.CWintabData.GetPacketQueueSize ( )

Get packet queue size for this data object's context.

Returns
Returns a packet queue size in #packets or 0 if fails
bool wHiteRabbiT.Common.Wacom.CWintabData.SetPacketQueueSize ( UInt32  numPkts_I)

Set the handler to be called when WT_PACKET events are received.

Parameters
handler_IWT_PACKET event handler supplied by the client.

Set packet queue size for this data object's context.

Parameters
numPkts_Idesired #packets in queue
Returns
Returns true if operation successful

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