IBookContentCmdData Class Reference

#include <IBookContentCmdData.h>

Inheritance diagram for IBookContentCmdData:

Public Types
enum	{ kDefaultIID = IID_IBOOKCONTENTCMDDATA }

Public Member Functions
virtual IDFile &	GetTargetBook ()=0
virtual void	SetTargetBook (const IDFile &bookFile)=0
virtual K2Vector< IDFile > &	GetContentFile ()=0
virtual void	SetContentFile (K2Vector< IDFile > &contentFileList)=0
virtual UIDList *	GetContentList ()=0
virtual void	SetContentList (UIDList *contentList)=0
virtual int32	GetDestPosition ()=0
virtual void	SetDestPosition (int32 destPos)=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 those commands relating to document operations within books (kBookBoss).

See Also

kAddDocToBookCmdBoss

kMoveDocInBookCmdBoss

kRemoveDocFromBookCmdBoss

kConstructContentCmdBoss

Member Function Documentation

virtual K2Vector<IDFile>& IBookContentCmdData::GetContentFile ( )

pure virtual

Get the list of IDFiles related to the contents.

Parameters

none

Returns

K2Vector<IDFile>& the list of IDFiles related to the contents.

virtual UIDList* IBookContentCmdData::GetContentList ( )

pure virtual

Get the UID list of book contents to be operated on(insert/remove).

Parameters

none

Returns

UIDList* the UID list of book contents.

virtual int32 IBookContentCmdData::GetDestPosition ( )

pure virtual

Get the position where we want to insert the content within the book.

Parameters

none

Returns

int32 the destination.

virtual IDFile& IBookContentCmdData::GetTargetBook ( )

pure virtual

Get the book which the contents are targeting to.

Parameters

none

Returns

IDFile& the book which the contents are targeting to.

virtual void IBookContentCmdData::SetContentFile ( K2Vector< IDFile > &  contentFileList )

pure virtual

Set the list of IDFiles representing the book contents to be operated on.

Parameters

contentFileList

IN the list of contents to be operated on.

virtual void IBookContentCmdData::SetContentList ( UIDList *  contentList )

pure virtual

Set the UID list of book contents to be operated on(insert/remove).

Parameters

contentList

IN the UID list of book contents.

virtual void IBookContentCmdData::SetDestPosition ( int32  destPos )

pure virtual

Set the position where we want want to insert the content within the book

Parameters

destPos

IN the destination.

virtual void IBookContentCmdData::SetTargetBook ( const IDFile &  bookFile )

pure virtual

Set the book which the contents are targeting to.

Parameters

bookFile

IN the target book.