wHiteRabbiT.Common.Wacom.CWintabContext Class Reference

Class to support access to Wintab context management. More...

Public Member Functions
	CWintabContext ()
	Default constructor sets all data bits to be captured. More...
HCTX	Open (HWND hwnd_I, bool enable_I)
	Open a Wintab context to the specified hwnd. More...
bool	Open ()
	Open a Wintab context that will send packet events to a message window. More...
bool	Close ()
	Close the context for this object. More...
bool	Enable (bool enable_I)
	Enable/disable this Wintab context. More...
bool	SetOverlapOrder (bool toTop_I)
	Sends a tablet context to the top or bottom of the order of overlapping tablet contexts More...

Properties
WintabLogContext	LogContext [get, set]
	Logical Wintab context managed by this object. More...
HCTX	HCtx [get]
	Handle (identifier) used to identify this context. More...
string	Name [get, set]
	Get/Set context name. More...
UInt32	Options [get, set]
	Specifies options for the context. More...
UInt32	Status [get, set]
	Specifies current status conditions for the context. More...
UInt32	Locks [get, set]
	Specifies which attributes of the context the application wishes to be locked. More...
UInt32	MsgBase [get, set]
	Specifies the range of message numbers that will be used for reporting the activity of the context. More...
UInt32	Device [get, set]
	Specifies the device whose input the context processes. More...
UInt32	PktRate [get, set]
	Specifies the desired packet report rate in Hertz. More...
WTPKT	PktData [get, set]
	Specifies which optional data items will be in packets returned from the context. More...
WTPKT	PktMode [get, set]
	Specifies whether the packet data items will be returned in absolute or relative mode. More...
WTPKT	MoveMask [get, set]
	Specifies which packet data items can generate move events in the context. More...
UInt32	BtnDnMask [get, set]
	Specifies the buttons for which button press events will be processed in the context. More...
UInt32	BtnUpMask [get, set]
	Specifies the buttons for which button release events will be processed in the context. More...
Int32	InOrgX [get, set]
	Specifies the X origin of the context's input area in the tablet's native coordinates. More...
Int32	InOrgY [get, set]
	Specifies the Y origin of the context's input area in the tablet's native coordinates. More...
Int32	InOrgZ [get, set]
	Specifies the Z origin of the context's input area in the tablet's native coordinates. More...
Int32	InExtX [get, set]
	Specifies the X extent of the context's input area in the tablet's native coordinates. More...
Int32	InExtY [get, set]
	Specifies the Y extent of the context's input area in the tablet's native coordinates. More...
Int32	InExtZ [get, set]
	Specifies the Z extent of the context's input area in the tablet's native coordinates. More...
Int32	OutOrgX [get, set]
	Specifies the X origin of the context's output area in context output coordinates. More...
Int32	OutOrgY [get, set]
	Specifies the Y origin of the context's output area in context output coordinates. More...
Int32	OutOrgZ [get, set]
	Specifies the Z origin of the context's output area in context output coordinates. More...
Int32	OutExtX [get, set]
	Specifies the X extent of the context's output area in context output coordinates. More...
Int32	OutExtY [get, set]
	Specifies the Y extent of the context's output area in context output coordinates. More...
Int32	OutExtZ [get, set]
	Specifies the Z extent of the context's output area in context output coordinates. More...
FIX32	SensX [get, set]
	Specifies the relative-mode sensitivity factor for the x axis. More...
FIX32	SensY [get, set]
	Specifies the relative-mode sensitivity factor for the y axis. More...
FIX32	SensZ [get, set]
	Specifies the relative-mode sensitivity factor for the Z axis. More...
bool	SysMode [get, set]
	Specifies the system cursor tracking mode. More...
Int32	SysOrgX [get, set]
	Specifies the X origin of the screen mapping area for system cursor tracking, in screen coordinates. More...
Int32	SysOrgY [get, set]
	Specifies the Y origin of the screen mapping area for system cursor tracking, in screen coordinates. More...
Int32	SysExtX [get, set]
	Specifies the X extent of the screen mapping area for system cursor tracking, in screen coordinates. More...
Int32	SysExtY [get, set]
	Specifies the Y extent of the screen mapping area for system cursor tracking, in screen coordinates. More...
FIX32	SysSensX [get, set]
	Specifies the system-cursor relative-mode sensitivity factor for the x axis. More...
FIX32	SysSensY [get, set]
	Specifies the system-cursor relative-mode sensitivity factor for the y axis. More...

Detailed Description

Class to support access to Wintab context management.

Constructor & Destructor Documentation

wHiteRabbiT.Common.Wacom.CWintabContext.CWintabContext

(

)

Default constructor sets all data bits to be captured.

Member Function Documentation

bool wHiteRabbiT.Common.Wacom.CWintabContext.Close

(

)

Close the context for this object.

Returns

true if context successfully closed

bool wHiteRabbiT.Common.Wacom.CWintabContext.Enable

(

bool

enable_I

)

Enable/disable this Wintab context.

Parameters

enable_I

true = enable

Returns

Returns true if completed successfully

HCTX wHiteRabbiT.Common.Wacom.CWintabContext.Open	(	HWND	hwnd_I,
		bool	enable_I
	)

Open a Wintab context to the specified hwnd.

Parameters

hwnd_I	parent window for the context
enable_I	true to enable, false to disable

Returns

Returns non-zero context handle if successful.

bool wHiteRabbiT.Common.Wacom.CWintabContext.Open

(

)

Open a Wintab context that will send packet events to a message window.

Returns

Returns true if successful.

bool wHiteRabbiT.Common.Wacom.CWintabContext.SetOverlapOrder

(

bool

toTop_I

)

Sends a tablet context to the top or bottom of the order of overlapping tablet contexts

Parameters

toTop_I

true = send tablet to top of order

Returns

Returns true if successsful

Property Documentation

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.BtnDnMask

getset

Specifies the buttons for which button press events will be processed in the context.

In the case of overlapping contexts, button press events for buttons that are not selected in this field may be processed by underlying contexts.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.BtnUpMask

getset

Specifies the buttons for which button release events will be processed in the context.

In the case of overlapping contexts, button release events for buttons that are not selected in this field may be processed by underlying contexts. If both press and release events are selected for a button (see the BtnDnMask property), then the interface will cause the context to implicitly capture all tablet events while the button is down. In this case, events occurring outside the context will be clipped to the context and processed as if they had occurred in the context. When the button is released, the context will receive the button release event, and then event processing will return to normal.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.Device

getset

Specifies the device whose input the context processes.

HCTX wHiteRabbiT.Common.Wacom.CWintabContext.HCtx

get

Handle (identifier) used to identify this context.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.InExtX

getset

Specifies the X extent of the context's input area in the tablet's native coordinates.

Value is clipped to the tablet native coordinate space when the context is opened or modified.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.InExtY

getset

Specifies the Y extent of the context's input area in the tablet's native coordinates.

Value is clipped to the tablet native coordinate space when the context is opened or modified.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.InExtZ

getset

Specifies the Z extent of the context's input area in the tablet's native coordinates.

Value is clipped to the tablet native coordinate space when the context is opened or modified.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.InOrgX

getset

Specifies the X origin of the context's input area in the tablet's native coordinates.

Value is clipped to the tablet native coordinate space when the context is opened or modified.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.InOrgY

getset

Specifies the Y origin of the context's input area in the tablet's native coordinates.

Value is clipped to the tablet native coordinate space when the context is opened or modified.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.InOrgZ

getset

Specifies the Z origin of the context's input area in the tablet's native coordinates.

Value is clipped to the tablet native coordinate space when the context is opened or modified.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.Locks

getset

Specifies which attributes of the context the application wishes to be locked.

Lock conditions specify attributes of the context that cannot be changed once the context has been opened (calls to WTConfig will have no effect on the locked attributes). The lock conditions can be combined by using the bitwise OR operator. The lcLocks field can be any combination of the values defined in ECTXLockValues. Locks can only be changed by the task or process that owns the context.

WintabLogContext wHiteRabbiT.Common.Wacom.CWintabContext.LogContext

getset

Logical Wintab context managed by this object.

WTPKT wHiteRabbiT.Common.Wacom.CWintabContext.MoveMask

getset

Specifies which packet data items can generate move events in the context.

Bits for items that are not part of the packet definition in the PktData property will be ignored. The bits for buttons, time stamp, and the packet identifier will also be ignored. In the case of overlapping contexts, movement events for data items not selected in this field may be processed by underlying contexts.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.MsgBase

getset

Specifies the range of message numbers that will be used for reporting the activity of the context.

string wHiteRabbiT.Common.Wacom.CWintabContext.Name

getset

Get/Set context name.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.Options

getset

Specifies options for the context.

These options can be combined by using the bitwise OR operator. The lcOptions field can be any combination of the values defined in ECTXOptionValues.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.OutExtX

getset

Specifies the X extent of the context's output area in context output coordinates.

Value is used in coordinate scaling for absolute mode only.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.OutExtY

getset

Specifies the Y extent of the context's output area in context output coordinates.

Value is used in coordinate scaling for absolute mode only.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.OutExtZ

getset

Specifies the Z extent of the context's output area in context output coordinates.

Value is used in coordinate scaling for absolute mode only.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.OutOrgX

getset

Specifies the X origin of the context's output area in context output coordinates.

Value is used in coordinate scaling for absolute mode only.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.OutOrgY

getset

Specifies the Y origin of the context's output area in context output coordinates.

Value is used in coordinate scaling for absolute mode only.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.OutOrgZ

getset

Specifies the Z origin of the context's output area in context output coordinates.

Value is used in coordinate scaling for absolute mode only.

WTPKT wHiteRabbiT.Common.Wacom.CWintabContext.PktData

getset

Specifies which optional data items will be in packets returned from the context.

Requesting unsupported data items will cause Open() to fail.

WTPKT wHiteRabbiT.Common.Wacom.CWintabContext.PktMode

getset

Specifies whether the packet data items will be returned in absolute or relative mode.

If the item's bit is set in this field, the item will be returned in relative mode. Bits in this field for items not selected in the PktData property will be ignored. Bits for data items that only allow one mode (such as the packet identifier) will also be ignored.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.PktRate

getset

Specifies the desired packet report rate in Hertz.

Once the con-text is opened, this field will contain the actual report rate.

FIX32 wHiteRabbiT.Common.Wacom.CWintabContext.SensX

getset

Specifies the relative-mode sensitivity factor for the x axis.

FIX32 wHiteRabbiT.Common.Wacom.CWintabContext.SensY

getset

Specifies the relative-mode sensitivity factor for the y axis.

FIX32 wHiteRabbiT.Common.Wacom.CWintabContext.SensZ

getset

Specifies the relative-mode sensitivity factor for the Z axis.

UInt32 wHiteRabbiT.Common.Wacom.CWintabContext.Status

getset

Specifies current status conditions for the context.

These conditions can be combined by using the bitwise OR operator. The lcStatus field can be any combination of the values defined in ECTXStatusValues.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.SysExtX

getset

Specifies the X extent of the screen mapping area for system cursor tracking, in screen coordinates.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.SysExtY

getset

Specifies the Y extent of the screen mapping area for system cursor tracking, in screen coordinates.

bool wHiteRabbiT.Common.Wacom.CWintabContext.SysMode

getset

Specifies the system cursor tracking mode.

Zero specifies absolute; non-zero means relative.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.SysOrgX

getset

Specifies the X origin of the screen mapping area for system cursor tracking, in screen coordinates.

Int32 wHiteRabbiT.Common.Wacom.CWintabContext.SysOrgY

getset

Specifies the Y origin of the screen mapping area for system cursor tracking, in screen coordinates.

FIX32 wHiteRabbiT.Common.Wacom.CWintabContext.SysSensX

getset

Specifies the system-cursor relative-mode sensitivity factor for the x axis.

FIX32 wHiteRabbiT.Common.Wacom.CWintabContext.SysSensY

getset

Specifies the system-cursor relative-mode sensitivity factor for the y axis.

---

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

• D:/wHiteRabbiT/wHiteRabbiT-sTudio/trunk/Unity_4_5/Assets/WR_wHiteRabbiT-sTudio/WRFramework/Common/Wacom/CWintabContext.cs