XRefBuildingBlock.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.
// 
//========================================================================================


// ----- Interfaces -----
#include "IPMStream.h"
#include "ITextModel.h"

// ----- Includes -----
#include <map>
#include "EscapeTable.h"

#ifdef PUBLIC_BUILD
#endif

class XRefBuildingBlock
{
public: 
 typedef object_type data_type;

 enum XRefBuildingBlockType
 {
 kInvalidXRefBBType = -1,
 kXRefBBCustomString = 0,
 kXRefBBFileName,
 kXRefBBChapterNumber,
 kXRefBBPageNumber,
 kXRefBBFullParagraph,
 kXRefBBParagraphNumber,
 kXRefBBParagraphText,
 kXRefBBBookmarkName,
 kMaxXRefBBType,
 } ;
 
 XRefBuildingBlock() : fType(kInvalidXRefBBType), fCharStyleUID(kInvalidUID), fCustomText(), fIncludeDelim(kFalse) {}
 
 XRefBuildingBlock(XRefBuildingBlockType type) : fType(type), fCharStyleUID(kInvalidUID), fIncludeDelim(kFalse) {}
 XRefBuildingBlock(XRefBuildingBlockType type, UID charStyle) : fType(type), fCharStyleUID(charStyle), fIncludeDelim(kFalse) {}
 XRefBuildingBlock(const XRefBuildingBlock& block);

 ~XRefBuildingBlock() {}

 XRefBuildingBlock& operator = (const XRefBuildingBlock &copy);
 bool16 operator==(const XRefBuildingBlock &other) const;
 bool16 operator != (const XRefBuildingBlock &other) const
 { return !(*this == other); }
 
 XRefBuildingBlockType GetType() const { return fType; }
 void SetType(XRefBuildingBlockType type);

 UID GetCharacterStyle() const { return fCharStyleUID; }
 void SetCharacterStyle(UID charStyle);

 void SetCustomText(const PMString& customText);
 PMString GetCustomText() const { return fCustomText; }

 void SetDelimiter(const UTF32TextChar& delim, bool16 includeDelim);
 void SetDelimiter(const UTF32TextChar& delim) { fDelim = delim; }
 void SetIncludeDelim(bool16 includeDelim) { fIncludeDelim = includeDelim; }
 UTF32TextChar GetDelimiter() const { return fDelim; }
 bool16 IncludeDelimiter() const { return fIncludeDelim; }
 
 PMString GenerateElementString() const;
 PMString GenerateSourceString(const ITextModel* textModel, TextIndex destIndex, bool16 externDest, 
 std::map<TextIndex, WideString>* variableLocations, std::map<TextIndex, TextIndex>* inlineLocations) const;
 
 void ReadWrite(IPMStream *s);

 static bool NeedToStripForParaNum(const UTF32TextChar& c);
 
private: 
 XRefBuildingBlockType fType;
 UID fCharStyleUID;
 PMString fCustomText;
 UTF32TextChar fDelim;
 bool16 fIncludeDelim;
};