InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICustomIBeamData Class Referenceabstract

#include <ICustomIBeamData.h>

Inheritance diagram for ICustomIBeamData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICUSTOMIBEAMDATA }
 

Public Member Functions

virtual bool16 GetCursor (const SysPoint globalPoint, ICursorMgr::eCursorModifierState, IControlView *controlView, CursorSpec &spec) const =0
 
virtual ITrackerCreateTracker (const IEvent *event, IControlView *controlView) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The IBeam Tool looks for this interface on OwnedItems to help it set the appropriate cursor and spawn the appropriate trackers for the OwnedItem.

Member Function Documentation

virtual ITracker* ICustomIBeamData::CreateTracker (const IEventevent,
IControlViewcontrolView 
) const
pure virtual

Returns a tracker for the Text IBeam Tool which has wandered over the ICustomIBeamData.

Parameters
eventThe event
controlViewThe relevant ControlView
Returns
ITracker* A pointer to the new tracker object or nil if no tracker is returned.
virtual bool16 ICustomIBeamData::GetCursor (const SysPoint globalPoint,
ICursorMgr::eCursorModifierState ,
IControlViewcontrolView,
CursorSpecspec 
) const
pure virtual

Returns a cursor for the Text IBeam Tool which has wandered over the ICustomIBeamData. If the item fails to return a cursor then the appropriate default IBeam is used.

Parameters
globalPointIn Pasteboard coordinates
ICursorMgr::eCursorModifierStateCursor Modifier State
controlViewThe relevant ControlView
specReturn the cursor resource spec
Returns
bool16 kTrue if a cursor was returned via spec kFalse if no cursor