IndexHeaderGroup.h

//========================================================================================
// 
// $File$
// 
// Owner: Bertrand Lechevalier
// 
// $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 class to store one Header Group (Symbol, Numeric, Alphabet, Kana...).
// 
//========================================================================================

#ifndef __INDEXHEADERGROUP__
#define __INDEXHEADERGROUP__

#include "IPMStream.h"

#include "LanguageID.h"
#include "WideString.h"
#include "IndexSectionHeader.h"
#include "K2Vector.h"

class IndexHeaderGroup
{
 public:
 typedef object_type data_type;

 IndexHeaderGroup():
 fName(""),
 fUIHeader(""),
 fTextHeader(""),
 fVisible(kFalse)
 {}

 bool16 operator==(const IndexHeaderGroup& other) const
 {
 return ( (fUIHeader == other.fUIHeader) &&
 (fName == other.fName) && 
 (fTextHeader == other.fTextHeader) && 
 (fVisible == other.fVisible) &&
 (fSectionHeadersList == other.fSectionHeadersList)); 
 }

 bool16 operator!=(const IndexHeaderGroup& other) const
 {
 return ( !(*this == other) ); 
 }

 void AppendSectionHeader(const IndexSectionHeader& sectionHeader)
 {
 fSectionHeadersList.push_back(sectionHeader);
 }

 const IndexSectionHeader& GetNthSectionHeader(int32 i) const
 {
 ASSERT_MSG(i >= 0 && i < fSectionHeadersList.size(), "GetNthSectionHeader::IndexSectionHeadersSet: bad index");
 return fSectionHeadersList[i];
 }

 void ReadWrite(IPMStream *s)
 {
 fName.ReadWrite(s);

 fUIHeader.ReadWrite(s);

 fTextHeader.ReadWrite(s);

 s->XferBool(fVisible);

 if (s->IsReading())
 {
 int32 numHeaders = fSectionHeadersList.size();

 s->XferInt32(numHeaders);

 fSectionHeadersList.clear();
 fSectionHeadersList.reserve(numHeaders);

 int32 i;
 for (i = 0; i < numHeaders; i++)
 {
 IndexSectionHeader sectionHeader;

 sectionHeader.ReadWrite(s);

 fSectionHeadersList.push_back(sectionHeader);
 }
 }
 else
 {
 int32 numHeaders = fSectionHeadersList.size();

 s->XferInt32(numHeaders);
 int32 i;
 for (i = 0; i < numHeaders; i++)
 fSectionHeadersList[i].ReadWrite(s);
 }
 }

 PMString fName; // Internal name
 PMString fUIHeader; // String used to display the Group in the UI
 WideString fTextHeader; // String used to display the Group in the Pub text
 bool16 fVisible;
 K2Vector<IndexSectionHeader> fSectionHeadersList; // List of the section headers
};

#endif // __INDEXHEADERGROUP__