ISyncMasterPageData.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Comments: Data interface for storing a map between style name(key) and doc name(value).
// 
//========================================================================================

#ifndef __ISYNCMASTERPAGEDATA__
#define __ISYNCMASTERPAGEDATA__

// ----- Interface files

#include "IPMStream.h"
#include "IPMUnknown.h"

// ----- Include files

#include "KeyValuePair.h"
#include "K2Vector.h"

// ----- ID files

#include "MasterPageID.h"

class MasterPageItemInfo
{
 public:
 typedef object_type data_type;

 MasterPageItemInfo() {}

 MasterPageItemInfo(
 const UID& pageUID, // UID of page 
 const UID& pageItemUID):// UID of page items on master spread
 fPageUID(pageUID),
 fPageItemUID(pageItemUID) {}
 
 bool16 operator==(const MasterPageItemInfo& other) const
 { 
 //return ((fPageUID == other.fPageUID) && (fPageItemUID == other.fPageItemUID));
 return (fPageItemUID == other.fPageItemUID);
 }

 void KeyReadWrite(IPMStream *s)
 {
 s->XferInt32((int32&)fPageUID);
 s->XferInt32((int32&)fPageItemUID);
 }

 void ValueReadWrite(IPMStream *s)
 {
 s->XferReference(fPageUID);
 s->XferReference(fPageItemUID);
 }

 UID fPageUID;
 UID fPageItemUID;
};

typedef K2Vector<KeyValuePair<MasterPageItemInfo, MasterPageItemInfo> > SyncMasterSpreadPageItemMap;
typedef K2Vector<KeyValuePair<UID, UID> > SyncMasterSpreadPageMap;

class ISyncMasterPageData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISYNCMASTERPAGEDATA };

 enum SyncMasterPageOptions { kReplace = 1, kRename } ;

 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;
};

#endif // __ISYNCMASTERPAGEDATA__