InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IEventConverter Class Referenceabstract

#include <IEventConverter.h>

Inheritance diagram for IEventConverter:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEVENTCONVERTER }
 

Public Member Functions

virtual void ConvertIEvent (IEvent &coreEvent)=0
 
virtual void StampWithEndTime (IEvent &theEvent)=0
 
virtual void TrackingMouse (bool16 isTracking)=0
 
virtual bool16 IsTrackingMouse () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The event converter takes a platform event and changes it into a Shuksan IEvent. Usually this is called from our main event loop. We fetch an OS event, stuff it into a PlatformEvent, then we call this interface to fully populate the IEvent with required information, including the event type. After that, the IEvent is usually sent out via a call to IEventDispatcher.

Member Function Documentation

virtual void IEventConverter::ConvertIEvent (IEvent & coreEvent)
pure virtual

Takes an IEvent which merely contains a platform event, and converts it into a real core IEvent.

virtual bool16 IEventConverter::IsTrackingMouse () const
pure virtual

returns whether currently tracking the mouse or not

virtual void IEventConverter::StampWithEndTime (IEvent & theEvent)
pure virtual

Called after events are processed to stamp event with end time.

virtual void IEventConverter::TrackingMouse (bool16 isTracking)
pure virtual

During mouse tracking (i.e. between the mouse down, mouse drag, and mouse up) don't accept other events that could terminate the drag.