IInsertIndexMarkCmdData Class Reference

#include <IInsertIndexMarkCmdData.h>

Inheritance diagram for IInsertIndexMarkCmdData:

Public Types
enum	{ kDefaultIID = IID_IINSERTINDEXMARKCMDDATA }

Public Member Functions
virtual const UIDRef &	GetPageEntryUIDRef () const =0
virtual void	SetPageEntryUIDRef (const UIDRef &pageEntryUIDRef)=0
virtual PageEntryInfoArray const &	GetPageEntriesInfo () const =0
virtual void	SetPageEntriesInfo (PageEntryInfoArray const &pageEntries)=0
virtual const UIDRef &	GetTargetItem () const =0
virtual void	SetTargetItem (const UIDRef &targetItem)=0
virtual void	SkipInsertingMarkerCharacter ()=0
virtual bool16	ShouldSkipInsertingMarkerCharacter () 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

Command data interface for creating a topic List. This interface holds the data for kInsertIndexMarkCmdBoss which is used to insert the index markers in the text.

SetPageEntryUIDRef and SetPageEntriesInfo should not be called on the same command instance.

See Also

kInsertIndexMarkCmdBoss

Member Function Documentation

virtual PageEntryInfoArray const& IInsertIndexMarkCmdData::GetPageEntriesInfo ( ) const

pure virtual

Gets the page entries for the command.

Returns

array of page entries and their positions.

virtual const UIDRef& IInsertIndexMarkCmdData::GetPageEntryUIDRef ( ) const

pure virtual

Gets the page entry for the command.

Returns

the UIDRef of the page entry.

virtual const UIDRef& IInsertIndexMarkCmdData::GetTargetItem ( ) const

pure virtual

Gets the target of the command.

Returns

the UIDRef of the target item (usually the text model).

virtual void IInsertIndexMarkCmdData::SetPageEntriesInfo ( PageEntryInfoArray const &  pageEntries )

pure virtual

Sets the page entries for the command. This method is used when multiple index markers need to be set.

Parameters

pageEntries

[IN] - array of page entries and their positions.

virtual void IInsertIndexMarkCmdData::SetPageEntryUIDRef ( const UIDRef &  pageEntryUIDRef )

pure virtual

Sets the page entry for the command. This method is used when the command should insert only one index marker. For inserting multiple index markers use SetPageEntriesInfo.

Parameters

pageEntryUIDRef

[IN] - the UIDRef of the page entry for which we want to insert the index marker. The index marker will be inserted at the beginning of the word where the cursor is.

virtual void IInsertIndexMarkCmdData::SetTargetItem ( const UIDRef &  targetItem )

pure virtual

Sets the target of the command.

Parameters

targetItem

[IN] - the UIDRef of the target item (usually the text model).

virtual bool16 IInsertIndexMarkCmdData::ShouldSkipInsertingMarkerCharacter ( ) const

pure virtual

Specifies if the index marker characters are already inserted in the text model.

virtual void IInsertIndexMarkCmdData::SkipInsertingMarkerCharacter ( )

pure virtual

Specifies if the index marker characters are already inserted in the text model.