Export (0) Print
Expand All

IRealTimeStylus interface

Applies to: desktop apps only

Handles the stylus packet data from a digitizer in real time.

Members

The IRealTimeStylus interface inherits from the IUnknown interface. IRealTimeStylus also has these types of members:

Methods

The IRealTimeStylus interface has these methods.

MethodDescription
AddCustomStylusDataToQueue

Adds custom data to the specified queue.

AddStylusAsyncPlugin

Adds an IStylusAsyncPlugin to the asynchronous plug-in collection at the specified index.

AddStylusSyncPlugin

Adds an IStylusSyncPlugin to the synchronous plug-in collection at the specified index.

ClearStylusQueues

Clears both the input and the output queues of data.

GetAllTabletContextIds

Retrieves an array of TABLET_CONTEXT_IDs.

GetDesiredPacketDescription

Retrieves the properties that are requested to be included in the packet stream.

GetPacketDescriptionData

Retrieves the actual properties that will be received from the hardware based on the request made by the call to IRealTimeStylus::SetDesiredPacketDescription Method.

GetStylusAsyncPlugin

Retrieves the plug-in at the specified index.

GetStylusAsyncPluginCount

Gets the count of plug-ins in the collection.

GetStyluses

Retrieves the collection of styluses this instance of the RealTimeStylus Class object has encountered.

GetStylusForId

Retrieves a stylus for the specific stylus identifier.

GetStylusSyncPlugin

Retrieves the plug-in at the specified index.

GetStylusSyncPluginCount

Gets the count of plug-ins in the collection.

GetTablet

Retrieves an IInkTablet Interface object to the caller.

GetTabletContextIdFromTablet

Retrieves the TABLET_CONTEXT_ID for a specific tablet.

GetTabletFromTabletContextId

Retrieves an IInkTablet Interface for a specific tablet context.

RemoveAllStylusAsyncPlugins

Removes all the plug-ins from the asynchronous plug-in collection.

RemoveAllStylusSyncPlugins

Removes all the plug-ins from the synchronous plug-in collection.

RemoveStylusAsyncPlugin

Removes and retrieves an IStylusAsyncPlugin from the collection at the specified index.

RemoveStylusSyncPlugin

Removes and optionally retrieves an IStylusSyncPlugin from the collection at the specified index.

SetAllTabletsMode

Sets the mode for the RealTimeStylus to forward packets from all attached tablets.

SetDesiredPacketDescription

Requests which properties should be included in the packet stream.

SetSingleTabletMode

Sets the mode for the RealTimeStylus to forward packets from a single attached tablet.

 

Properties

The IRealTimeStylus interface has these properties.

PropertyAccess typeDescription

ChildRealTimeStylusPlugin

Read/write

Enables the developer to add a RealTimeStylus Class object as an asynchronous plug-in of the current RealTimeStylus Class object.

Enabled

Read/write

Enables or disables the collection of stylus data.

HWND

Read/write

Gets or sets the window handle associated with this RealTimeStylus Class object.

WindowInputRectangle

Read/write

Gets or sets the window input rectangle for the RealTimeStylus Class object.

 

Remarks

This interface is implemented by the RealTimeStylus Class.

Extensibility is provided through synchronous and asynchronous plug-in models, using the IStylusSyncPlugin and IStylusAsyncPlugin interfaces respectively to conduct custom processing. Use asynchronous plug-ins for computationally intense operations to avoid blocking the packet stream.

We recommend that you do not use the IStylusSyncPlugin interface implementations for CPU and time-intensive operations since this blocks the packet stream flow. These operations should be conducted in IStylusAsyncPlugin interface implementation classes which run on a different thread than the thread that maintains the packet stream flow.

Note  The synchronous and asynchronous plug-in collections on the RealTimeStylus Class can be modified without disabling and then re-enabling the RealTimeStylus Class object.

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

RTSCom.h (also requires RTSCom_i.c)

DLL

RTSCom.dll

See also

DynamicRenderer Class
RealTimeStylus Reference
RealTimeStylus Class
RealTimeStylus Classes and Interfaces

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft