ISyncMasterPageData Class Reference

#include <ISyncMasterPageData.h>

Inheritance diagram for ISyncMasterPageData:

Public Types
enum	{ kDefaultIID = IID_ISYNCMASTERPAGEDATA }
enum	SyncMasterPageOptions { kReplace = 1, kRename }

Public Member Functions
virtual void	SetSyncMasterSpreadPageItemMap (const SyncMasterSpreadPageItemMap &newMap)=0
virtual const SyncMasterSpreadPageItemMap &	GetSyncMasterSpreadPageItemMap ()=0
virtual void	SetSyncMasterSpreadPageMap (const SyncMasterSpreadPageMap &newMap)=0
virtual const SyncMasterSpreadPageMap &	GetSyncMasterSpreadPageMap ()=0
virtual const ISyncMasterPageData::SyncMasterPageOptions &	GetSyncMasterPagePageItemOptionSetting ()=0
virtual void	SetSyncMasterPagePageItemOptionSetting (const ISyncMasterPageData::SyncMasterPageOptions &pageItemOption)=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

This interface resides on kDocBoss. It has a map recording which page item on the target was loaded from source document. It also caches the sync master page options (either replace or rename).

Member Function Documentation

virtual const ISyncMasterPageData::SyncMasterPageOptions& ISyncMasterPageData::GetSyncMasterPagePageItemOptionSetting ( )

pure virtual

Get the option of synchronization master spreads.

Returns

ISyncMasterPageData::SyncMasterPageOptions, either kReplace or kRename.

virtual const SyncMasterSpreadPageItemMap& ISyncMasterPageData::GetSyncMasterSpreadPageItemMap ( )

pure virtual

Get the map about synchronizing master spread page item info on the document boss.

Returns

SyncMasterSpreadPageItemMap.

virtual const SyncMasterSpreadPageMap& ISyncMasterPageData::GetSyncMasterSpreadPageMap ( )

pure virtual

Get the map about synchronizing master spread page info on the document boss.

Returns

SyncMasterSpreadPageMap.

virtual void ISyncMasterPageData::SetSyncMasterPagePageItemOptionSetting ( const ISyncMasterPageData::SyncMasterPageOptions &  pageItemOption )

pure virtual

Set the option of synchronization master spreads.

Parameters

pageItemOption

[IN]: either kReplace or kRename.

virtual void ISyncMasterPageData::SetSyncMasterSpreadPageItemMap ( const SyncMasterSpreadPageItemMap &  newMap )

pure virtual

Set synchronizing master spread page item info on the document boss which has source MasterPageItemInfo as key and target MasterPageItemInfo as value.

Parameters

newMap

[IN] the new map to be set.

virtual void ISyncMasterPageData::SetSyncMasterSpreadPageMap ( const SyncMasterSpreadPageMap &  newMap )

pure virtual

Set synchronizing master spread page which has the source page UID as key and target page UID as value.

Parameters

newMap

[IN] the new map to be set.