IXRefFormat.h

//========================================================================================
// 
// $File$
// 
// Owner: Jianlan Song
// 
// $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.
// 
//========================================================================================


#include "IPMUnknown.h"
#include "IOwnedItem.h"

#include "HyperlinkID.h"

#include "XRefBuildingBlock.h"

#define kDefaultXRefFormatCount 9

typedef struct CharStyleRange
{
 typedef base_type data_type;
 
 CharStyleRange() : charStyle(kInvalidUID), startOffset(0), length(0) {}
 bool16 operator==(const CharStyleRange& s) const 
 { return ( charStyle == s.charStyle && startOffset == s.startOffset && length == s.length); }
 
 UID charStyle;
 TextIndex startOffset;
 int32 length;
} CharStyleRange;

class IXRefFormat : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IXREFFORMAT };

 virtual void CopyData(const IXRefFormat* other) = 0;
 
 virtual void SetName(const PMString & formatName) = 0;
 virtual PMString GetName() const = 0;

 virtual void SetCharacterStyle(UID charStyle) = 0;
 virtual UID GetCharacterStyle() const = 0;
 
 virtual void SetBuildingBlocks(const K2Vector<XRefBuildingBlock>& buildingBlocks) = 0;

 virtual void GetBuildingBlocks(K2Vector<XRefBuildingBlock>& buildingBlocks) const = 0;
 
 virtual int32 GetBuildingBlockCount() const = 0;

 virtual bool16 GetNthBuildingBlock(int32 index, XRefBuildingBlock& buildingBlock) const = 0;

 virtual bool16 HasParagraphBlock() const = 0;
 
 virtual PMString GenerateBlocksString() const = 0;
 
 virtual PMString GenerateSourceString(const IOwnedItem* destMarker, bool16 isParagraphDest, K2Vector<CharStyleRange>& charStyleRanges,
 K2Vector<uint32>& pageNumLocations, K2Vector<uint32>& chapterNumLocations, std::map<TextIndex, WideString>* variableLocations,
 std::map<TextIndex, TextIndex>* inlineLocations) const = 0;
};