IRealTimeStylus interface

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

Methods

The IRealTimeStylus interface has these methods.

Method Description
IRealTimeStylus::AddCustomStylusDataToQueue Adds custom data to the specified queue of the RealTimeStylus Class object.
IRealTimeStylus::AddStylusAsyncPlugin Adds an IStylusAsyncPlugin to the asynchronous plug-in collection at the specified index.
IRealTimeStylus::AddStylusSyncPlugin Adds an IStylusSyncPlugin to the synchronous plug-in collection at the specified index.
IRealTimeStylus::ClearStylusQueues Clears the RealTimeStylus Class input and output queues of data.
IRealTimeStylus::get_ChildRealTimeStylusPlugin Gets or sets a RealTimeStylus object as an asynchronous plug-in of the current RealTimeStylus object.
IRealTimeStylus::get_Enabled Gets or sets a value that specifies whether the RealTimeStylus object collects tablet pen data.
IRealTimeStylus::get_HWND Gets or sets the handle value associated with the window the RealTimeStylus object uses.
IRealTimeStylus::get_WindowInputRectangle Gets or sets the window input rectangle for the RealTimeStylus Class object.
IRealTimeStylus::GetAllTabletContextIds Retrieves an array containing all of the currently active tablet context identifiers.
IRealTimeStylus::GetDesiredPacketDescription Retrieves the list of properties that have been requested to be included in the packet stream.
IRealTimeStylus::GetPacketDescriptionData Retrieves the packet properties and scaling factors.
IRealTimeStylus::GetStylusAsyncPlugin Retrieves the plug-in at the specified index in the asynchronous plug-in collection.
IRealTimeStylus::GetStylusAsyncPluginCount Retrieves the number of plug-ins in the asynchronous plug-in collection.
IRealTimeStylus::GetStyluses Retrieves the collection of styluses the RealTimeStylus Class object has encountered.
IRealTimeStylus::GetStylusForId Retrieves a stylus for the specified stylus identifier.
IRealTimeStylus::GetStylusSyncPlugin Retrieves the plug-in at the specified index in the synchronous plug-in collection.
IRealTimeStylus::GetStylusSyncPluginCount Retrieves the number of plug-ins in the synchronous plug-in collection.
IRealTimeStylus::GetTablet Retrieves an IInkTablet Interface object to the caller.
IRealTimeStylus::GetTabletContextIdFromTablet Retrieves the TabletContextId property that is associated with a given tablet digitizer object.
IRealTimeStylus::GetTabletFromTabletContextId Retrieves an IInkTablet Interface for a specified tablet context.
IRealTimeStylus::put_Enabled Gets or sets a value that specifies whether the RealTimeStylus object collects tablet pen data.
IRealTimeStylus::put_HWND Gets or sets the handle value associated with the window the RealTimeStylus object uses.
IRealTimeStylus::put_WindowInputRectangle Gets or sets the window input rectangle for the RealTimeStylus Class object.
IRealTimeStylus::RemoveAllStylusAsyncPlugins Removes all the plug-ins from the asynchronous plug-in collection.
IRealTimeStylus::RemoveAllStylusSyncPlugins Removes all of the plug-ins from the synchronous plug-in collection.
IRealTimeStylus::RemoveStylusAsyncPlugin Removes and optionally returns an IStylusAsyncPlugin with the specified index in the asynchronous plug-in collection.
IRealTimeStylus::RemoveStylusSyncPlugin Removes an IStylusSyncPlugin from the collection at the specified index.
IRealTimeStylus::SetAllTabletsMode Sets the mode for the RealTimeStylus Class object to collect data from all digitizers.
IRealTimeStylus::SetDesiredPacketDescription Requests properties to be included in the packet stream.
IRealTimeStylus::SetSingleTabletMode Modifies the mode for RealTimeStylus Class (RTS) object to collect input from only one tablet object representing a digitizer attached to the Tablet PC. Stylus input from other digitizers is ignored by the RealTimeStylus.

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 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header rtscom.h

See Also

DynamicRenderer Class

RealTimeStylus Class

RealTimeStylus Classes and Interfaces

RealTimeStylus Reference