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

Class to access Wintab interface data. More...

Static Public Member Functions

static bool IsWintabAvailable ()
 Returns TRUE if Wintab service is running and responsive. More...
 
static String GetDeviceInfo ()
 Returns a string containing device name. More...
 
static CWintabContext GetDefaultDigitizingContext (ECTXOptionValues options_I=0)
 Returns the default digitizing context, with useful context overrides. More...
 
static CWintabContext GetDefaultSystemContext (ECTXOptionValues options_I=0)
 Returns the default system context, with useful context overrides. More...
 
static Int32 GetDefaultDeviceIndex ()
 Returns the default device. More...
 
static WintabAxis GetDeviceAxis (Int32 devIndex_I, EAxisDimension dim_I)
 Returns the WintabAxis object for specified device and dimension. More...
 
static WintabAxisArray GetDeviceOrientation (out bool tiltSupported_O)
 Returns a 3-element array describing the tablet's orientation range and resolution capabilities. More...
 
static WintabAxisArray GetDeviceRotation (out bool rotationSupported_O)
 Returns a 3-element array describing the tablet's rotation range and resolution capabilities More...
 
static UInt32 GetNumberOfDevices ()
 Returns the number of devices connected. More...
 
static bool IsStylusActive ()
 Returns whether a stylus is currently connected to the active cursor. More...
 
static string GetStylusName (EWTICursorNameIndex index_I)
 Returns a string containing the name of the selected stylus. More...
 
static Int32 GetMaxPressure (bool getNormalPressure_I=true)
 Return max normal pressure supported by tablet. More...
 
static WintabAxis GetTabletAxis (EAxisDimension dimension_I)
 Return the WintabAxis object for the specified dimension. More...
 

Detailed Description

Class to access Wintab interface data.

Member Function Documentation

static Int32 wHiteRabbiT.Common.Wacom.CWintabInfo.GetDefaultDeviceIndex ( )
static

Returns the default device.

If this value is -1, then it also known as a "virtual device".

Returns
static CWintabContext wHiteRabbiT.Common.Wacom.CWintabInfo.GetDefaultDigitizingContext ( ECTXOptionValues  options_I = 0)
static

Returns the default digitizing context, with useful context overrides.

Parameters
options_Icaller's options; OR'd into context options
Returns
A valid context object or null on error.
static CWintabContext wHiteRabbiT.Common.Wacom.CWintabInfo.GetDefaultSystemContext ( ECTXOptionValues  options_I = 0)
static

Returns the default system context, with useful context overrides.

Parameters
options_Icaller's options; OR'd into context options
Returns
A valid context object or null on error.
static WintabAxis wHiteRabbiT.Common.Wacom.CWintabInfo.GetDeviceAxis ( Int32  devIndex_I,
EAxisDimension  dim_I 
)
static

Returns the WintabAxis object for specified device and dimension.

Parameters
devIndex_IDevice index (-1 = virtual device)
dim_IDimension: AXIS_X, AXIS_Y or AXIS_Z
Returns
static String wHiteRabbiT.Common.Wacom.CWintabInfo.GetDeviceInfo ( )
static

Returns a string containing device name.

Returns
static WintabAxisArray wHiteRabbiT.Common.Wacom.CWintabInfo.GetDeviceOrientation ( out bool  tiltSupported_O)
static

Returns a 3-element array describing the tablet's orientation range and resolution capabilities.

Returns
static WintabAxisArray wHiteRabbiT.Common.Wacom.CWintabInfo.GetDeviceRotation ( out bool  rotationSupported_O)
static

Returns a 3-element array describing the tablet's rotation range and resolution capabilities

Returns
static Int32 wHiteRabbiT.Common.Wacom.CWintabInfo.GetMaxPressure ( bool  getNormalPressure_I = true)
static

Return max normal pressure supported by tablet.

Parameters
getNormalPressure_ITRUE=> normal pressure; FALSE=> tangential pressure (not supported on all tablets)
Returns
maximum pressure value or zero on error
static UInt32 wHiteRabbiT.Common.Wacom.CWintabInfo.GetNumberOfDevices ( )
static

Returns the number of devices connected.

Returns
static string wHiteRabbiT.Common.Wacom.CWintabInfo.GetStylusName ( EWTICursorNameIndex  index_I)
static

Returns a string containing the name of the selected stylus.

Parameters
index_Iindicates stylus type
Returns
static WintabAxis wHiteRabbiT.Common.Wacom.CWintabInfo.GetTabletAxis ( EAxisDimension  dimension_I)
static

Return the WintabAxis object for the specified dimension.

Parameters
dimension_IDimension to fetch (eg: x, y)
Returns
static bool wHiteRabbiT.Common.Wacom.CWintabInfo.IsStylusActive ( )
static

Returns whether a stylus is currently connected to the active cursor.

Returns
static bool wHiteRabbiT.Common.Wacom.CWintabInfo.IsWintabAvailable ( )
static

Returns TRUE if Wintab service is running and responsive.

Returns

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