gIIEPad Interface Reference

import "g_IIEPad.idl";

List of all members.

Public Member Functions
HRESULT	GetNumDevices ([out] int *p_iNumDevices)
HRESULT	OpenConnection ([in] int iDeviceNum,[in] gIIEPadEvent *p_EventHandler)
HRESULT	CloseConnection ()
HRESULT	ConnGetRanges ([out] int *p_min_x,[out] int *p_max_x,[out] int *p_min_y,[out] int *p_max_y,[out] int *p_min_press,[out] int *p_max_press,[out] int *p_nButtons)
HRESULT	ConnSetMouseOn ([in] boolean fState)
HRESULT	ConnGetMouseOn ([out] boolean *p_fState)
HRESULT	ConnSetEventNotification ([in] boolean fState)
HRESULT	ConnGetEventNotification ([out] boolean *p_fState)
HRESULT	ConnGetSerialNumber ([out] GUID *p_serialNum)
HRESULT	ConnPushMouseData ([in] byte dx,[in] byte dy,[in] char bmButtons)
HRESULT	DisplayDebugGUI ()
HRESULT	ShowConfigDialog ()
HRESULT	ConnGetPhysicalExtents ([out] double *pExtX,[out] double *pExtY)
HRESULT	ConnGetReportRate ([out] int *p_nPackets,[out] int *p_milliseconds)
HRESULT	GetFriendlyName ([in] GUID *pSerialNum,[out] BSTR *pFriendlyName)
HRESULT	SetFriendlyName ([in] GUID *pSerialNum,[in] BSTR FriendlyName)
HRESULT	GetSerialNumber ([in] int iDeviceNum,[out] GUID *p_serialNum)
HRESULT	EnumSerialNumberHistory ([in] int iDeviceNum,[out] GUID *p_serialNum)

---

Detailed Description

Main provider I/F for implementation. This is what all providers must implement.

Pads are physically mapped as follows:

    +===============================+
    + (0,0)                         +
    +                               +
    +                               +
    +                               +
    +                               +
    +                               +
    +                               +
    +                   (maxX,maxY) +
    +===============================+
    

It is up to the service provider to translate the low-level data into a compatable format.
Note that maxX and maxY do not necessarily indicate the aspect ratio of the device -- this is obtained via the ConnGetAspectRatio method.

Definition at line 212 of file g_IIEPad.idl.

---

Member Function Documentation

HRESULT gIIEPad::CloseConnection (   )

Closes an existing connection, if it exists. Note that this should not be called while processing data from a gIIEPadEvent callback.

HRESULT gIIEPad::ConnGetEventNotification (  [out] boolean *  p_fState  )

Returns the current client notifification state. See also: ConnSetEventNotification

HRESULT gIIEPad::ConnGetMouseOn (  [out] boolean *  p_fState  )

Returns the state of system mousing. If the service provider does not support system mousing this function will always return false. See also: ConnSetMouseOn

HRESULT gIIEPad::ConnGetPhysicalExtents (  [out] double *  pExtX, [out] double *  pExtY )

Gets the unit's physical extents in inches.

HRESULT gIIEPad::ConnGetRanges (  [out] int *  p_min_x, [out] int *  p_max_x, [out] int *  p_min_y, [out] int *  p_max_y, [out] int *  p_min_press, [out] int *  p_max_press, [out] int *  p_nButtons )

Returns the device-specific information on this device.

HRESULT gIIEPad::ConnGetReportRate (  [out] int *  p_nPackets, [out] int *  p_milliseconds )

Returns the # of reports per interval.

HRESULT gIIEPad::ConnGetSerialNumber (  [out] GUID *  p_serialNum  )

Returns the unit's unique serial number. On devices that do not have unique serial numbers.

HRESULT gIIEPad::ConnPushMouseData (  [in] byte  dx, [in] byte  dy, [in] char  bmButtons )

Pushes user-defined relative mouse data through device stack and back into the bottom of the system's mouse driver stack. This allows a user-mode program to supply system mousing information from the device, regardless of operating system. This may not be supported by all service providers.

HRESULT gIIEPad::ConnSetEventNotification (  [in] boolean  fState  )

Sets client data event message to On | off. The default is ON so that as soon as the connection is established the user will get callbacks on data events. See also: ConnGetEventNotification HandlePadData

HRESULT gIIEPad::ConnSetMouseOn (  [in] boolean  fState  )

Sets system mouse messaging state. This may not be supported in all service providers. See also: ConnGetMouseOn

HRESULT gIIEPad::DisplayDebugGUI (   )

Displays the internal debugging GUI for the service provider.

HRESULT gIIEPad::EnumSerialNumberHistory (  [in] int  iDeviceNum, [out] GUID *  p_serialNum )

Returns history of all unique serial numbers ever plugged into host for this provider. Returns S_OK until the last item is reached.

HRESULT gIIEPad::GetFriendlyName (  [in] GUID *  pSerialNum, [out] BSTR *  pFriendlyName )

Returns the friendly name of the device.

HRESULT gIIEPad::GetNumDevices (  [out] int *  p_iNumDevices  )

Returns the number of devices supported by this provider. In most cases this should be the actual number of devices present at the time of the call. See also: OpenConnection

HRESULT gIIEPad::GetSerialNumber (  [in] int  iDeviceNum, [out] GUID *  p_serialNum )

Returns the unit's unique serial number if the device is connected. This is done as "silently" and quickly as possible.

HRESULT gIIEPad::OpenConnection (  [in] int  iDeviceNum, [in] gIIEPadEvent *  p_EventHandler )

Opens a connection to device instance 'iDeviceNum' where 'iDeviceNum' is within the range of device reported by GetNumDevices. Caller must provide p_EventHandler method. See also: GetNumDevices HandlePadData

HRESULT gIIEPad::SetFriendlyName (  [in] GUID *  pSerialNum, [in] BSTR  FriendlyName )

Sets the friendly name of the device, if supported.

HRESULT gIIEPad::ShowConfigDialog (   )

Displays a pop-up dialog that configures the service provider. If no configuration is required, this shall return E_NOTIMPL.

---