IPositionMarkerData Class Reference

Inheritance diagram for IPositionMarkerData:

Public Types
enum	{ kDefaultIID = IID_IPOSITIONMARKERDATA }

Public Member Functions
virtual void	SetPositionMarker (const UIDRef &textModelRef, TextIndex textIndex)=0
virtual void	ClearPositionMarker ()=0
virtual UIDRef	GetTextModel ()=0
virtual TextIndex	GetTextIndex ()=0
virtual bool16	PositionMarkerExists ()=0
virtual bool16	PositionMarkerValid ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual void IPositionMarkerData::ClearPositionMarker ( )

pure virtual

Clear existing position marker.

virtual TextIndex IPositionMarkerData::GetTextIndex ( )

pure virtual

Returns the text index for the position of the current marker.

Returns

TextIndex of the position of the current marker

virtual UIDRef IPositionMarkerData::GetTextModel ( )

pure virtual

Returns the text model ref for the current position marker.

Returns

UIDRef of the model the position marker is within

virtual bool16 IPositionMarkerData::PositionMarkerExists ( )

pure virtual

Returns kTrue if TextModelRef is not UIDRef::gNull and TextIndex is not kInvalidTextIndex.

Returns

bool16

virtual bool16 IPositionMarkerData::PositionMarkerValid ( )

pure virtual

Returns kTrue if TextModelRef is a valid TextModel and TextIndex is within that model.

Returns

bool16

virtual void IPositionMarkerData::SetPositionMarker ( const UIDRef &  textModelRef, TextIndex  textIndex  )

pure virtual

These are direct non-command based methods. Set position marker.

Parameters

textModelRef	the model the new position marker is within
textIndex	position of the new marker