IndexTopicEntryNode.h

//========================================================================================
// 
// $File$
// 
// Owner: Michel Hutinel
// 
// $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 carry one Index Topic entry node.
// 
//========================================================================================

#ifndef __INDEXTOPICENTRYNODE__
#define __INDEXTOPICENTRYNODE__

#include "WideString.h"
#include "LanguageID.h"
#ifdef qME
#include "IIndexHeaderSet.h"
#include "PreferenceUtils.h"
#endif

class IndexTopicEntryNode
{
 public:
 typedef object_type data_type;

#ifdef qME
 IndexTopicEntryNode():
 fLevel()
 {
 InterfacePtr<const IIndexHeaderSet> pPrefsTopicListHeaderSet((IIndexHeaderSet*)::QuerySessionPreferences(IID_IINDEXHEADERSET));
 fLanguage = pPrefsTopicListHeaderSet->GetLanguageID();
 }
#else
 IndexTopicEntryNode():
 fLevel(),
 fLanguage(kLanguageUserDefault)
 {}
#endif

 bool16 operator==(const IndexTopicEntryNode& other) const
 {
 // We don't compare fIndexEntryList
 return ( (fLevel == other.fLevel) && 
 (fDisplayString == other.fDisplayString) && 
 (fSortString == other.fSortString) &&
 (fLanguage == other.fLanguage)); 
 }

 IndexTopicEntryNode& operator=(const IndexTopicEntryNode& other)
 {
 if (this != &other)
 {
 fLevel = other.fLevel;
 fDisplayString = other.fDisplayString;
 fSortString = other.fSortString;
 fLanguage = other.fLanguage; 
 }
 return *this;
 }

 const WideString& GetSortString() const
 {
 return (fSortString.Length() != 0 ? fSortString : fDisplayString);
 }

 const LanguageID& GetSortLanguage() const
 {
 return fLanguage;
 }

 const int16 & GetLevel() const { return fLevel;} ;

 int16 & GetLevel() { return fLevel;} ;
 
 WideString & GetDisplayString() {return fDisplayString;} ;

 const WideString & GetDisplayString() const {return fDisplayString;} ;
 
 LanguageID & GetLanguage() {return fLanguage;} ;

 const LanguageID & GetLanguage() const { return fLanguage;};
 
 WideString & GetSortStringReference() {return fSortString;};

 const WideString & GetSortStringReference() const {return fSortString;};

protected:
 int16 fLevel; // Level of the Node
 WideString fDisplayString; // String used to display the topic
 WideString fSortString; // String used to sort the topic
 LanguageID fLanguage; // Language of topic
};

#endif // __INDEXTOPICENTRYNODE__