IBookSyncOptions.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: This interface is used to define the synchronization options for book . 
// 
//========================================================================================

#ifndef __IBOOKSYNCOPTIONS__
#define __IBOOKSYNCOPTIONS__

#include "IPMUnknown.h"
#include "IPMStream.h"
#include "KeyValuePair.h"
#include "K2Vector.h"
#include "BookID.h"

class SyncStyleIDInfo
{
 public:
 typedef object_type data_type;

 SyncStyleIDInfo() : fTurnOn(kFalse) {}

 SyncStyleIDInfo(
 const PMIID styleID, // sync style interface id
 const PMString& styleName, // style name
 const bool16 turnOn) : // turn on/off flag
 fStyleID(styleID),
 fStyleName(styleName),
 fTurnOn(turnOn) {}
 
 bool16 operator==(const SyncStyleIDInfo& other) const
 { 
 return ( (fStyleID == other.fStyleID) && 
 (fStyleName == other.fStyleName) && 
 (fTurnOn == other.fTurnOn) ); 
 }

 void ReadWrite(IPMStream *s)
 {
 int32 styleID(0);
 if (s->IsReading())
 {
 s->XferInt32(styleID);
 fStyleID = (PMIID)styleID;
 }
 else
 s->XferInt32((int32&)fStyleID);

 fStyleName.ReadWrite(s);
 s->XferBool(fTurnOn);
 }

 PMIID fStyleID; // synchronization style interface id
 PMString fStyleName; // style name
 bool16 fTurnOn; // flag indicates if style is turned on or not, if it is turned on, we should synchronize it.
};

class IBookSyncOptions : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IBOOKSYNCOPTIONS };

 virtual const K2Vector<KeyValuePair<PMString, K2Vector<SyncStyleIDInfo> > >& GetSyncStyleMap() = 0;


 virtual void SetSyncStyleMap(const K2Vector<KeyValuePair<PMString, K2Vector<SyncStyleIDInfo> > >& styleMap) = 0;
};


#endif //__IBOOKSYNCOPTIONS__