IBookSyncCmdData Class Reference

#include <IBookSyncCmdData.h>

Inheritance diagram for IBookSyncCmdData:

Public Types
enum	{ kDefaultIID = IID_IBOOKSYNCCMDDATA }

Public Member Functions
virtual void	Set (IDFile &sysFile, UIDList *itemList, bool16 syncAll=kTrue, bool16 useDefaultOptions=kTrue, bool16 syncOptionsOnly=kTrue)=0
virtual IDFile	GetBookFile ()=0
virtual void	SetBookFile (const IDFile &BookFile)=0
virtual UIDList *	GetUIDList ()=0
virtual void	SetUIDList (UIDList *uidList)=0
virtual bool16	IsSyncAll ()=0
virtual bool16	UseDefaultOptions ()=0
virtual bool16	ToSyncOptionsOnly ()=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 associated with command to synchronize book (kBookBoss).

See Also

kBookSyncCmdBoss

Member Function Documentation

virtual IDFile IBookSyncCmdData::GetBookFile ( )

pure virtual

Get the book file where the synchronization operation happens.

Parameters

none

Returns

IDFile the book file.

virtual UIDList* IBookSyncCmdData::GetUIDList ( )

pure virtual

Get the list of chapters where the styles will copy to.

Parameters

none

Returns

UIDList* the list of chapters.

virtual bool16 IBookSyncCmdData::IsSyncAll ( )

pure virtual

Get the flag about if we do synchronize for all the chapters in the book or not.

Parameters

none

Returns

bool16 kTrue means we do synchronize all the chapters, otherwise return kFalse.

virtual void IBookSyncCmdData::Set ( IDFile &  sysFile, UIDList *  itemList, bool16  syncAll = kTrue, bool16  useDefaultOptions = kTrue, bool16  syncOptionsOnly = kTrue  )

pure virtual

Set all the synchronization command data.

Parameters

sysFile	IN the book file where the synchronization operation happens.
itemList	IN the list of target(file) we copy styles to.
syncAll	IN flag indicates if we should sync all the documents in the book or only the given documents(itemList).
useDefaultOptions	IN flag indicates if we use existing setting in the book or use the setting from current UI input.
syncOptionsOnly	IN flag indicates if we just save the sync options or do both save the sync options AND copying styles from source document to target document.

virtual void IBookSyncCmdData::SetBookFile ( const IDFile &  BookFile )

pure virtual

Set the book file.

Parameters

BookFile

IN the book file.

virtual void IBookSyncCmdData::SetUIDList ( UIDList *  uidList )

pure virtual

Set the list of chapters where the styles will copy to.

Parameters

uidList

IN the list of chapters.

virtual bool16 IBookSyncCmdData::ToSyncOptionsOnly ( )

pure virtual

Get the flag about if we just sync options or do sync chapters AND options.

Parameters

none

Returns

bool16 kTrue means sync options only, otherwise kFalse means sync options and sync chapters.

virtual bool16 IBookSyncCmdData::UseDefaultOptions ( )

pure virtual

Get the flag about if we use the default options to do sync operations or not.

Parameters

none

Returns

bool16 kTrue means use the current sync option on the book, kFalse means use the sync options from the UI.