ICHLFileNameTable.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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.
// 
//========================================================================================

#ifndef __ICHLFileNameTable__
#define __ICHLFileNameTable__

// Interface includes:
#include "IPMUnknown.h"

// General includes:
#include "LanguageID.h"

// Project includes:
#include "CHLID.h"

// Forward declarations:
class PMString;
class ILanguage;

#include "ICUForwardDeclare.h"

#include "unicode/uloc.h"
#include "unicode/ucol.h"
#include "unicode/coll.h"

struct CHLFileNameData
{
 typedef object_type data_type;

 LanguageID fLanguageID;

 PMString fLanguageName;

 PMString fPrimaryLanguageName;
 
 PMString fSubLanguageName;

 PMString fCoreFileName;

 PMString fHyphFileName;

 PMString fThesaurusFileName;

 PMString fDefaultUserDictFileName;

 U_ICU_NAMESPACE::Locale fICULocale;

 inline bool16 operator==(const CHLFileNameData& rData) const;
};

/* operator ==
*/
inline bool16 CHLFileNameData::operator==(const CHLFileNameData& rData) const
{
 return fLanguageID == rData.fLanguageID && 
 fPrimaryLanguageName == rData.fPrimaryLanguageName &&
 fSubLanguageName == rData.fSubLanguageName &&
 fCoreFileName == rData.fCoreFileName &&
 fHyphFileName == rData.fHyphFileName &&
 fThesaurusFileName == rData.fThesaurusFileName &&
 fDefaultUserDictFileName == rData.fDefaultUserDictFileName &&
 fICULocale == rData.fICULocale;
}


class ICHLFileNameTable : public IPMUnknown
{
 public:

 enum { kDefaultIID = IID_ICHLFILENAMETABLE };
 
 virtual void Install(const PMString& rPath) = 0;
 
 virtual int32 GetEntriesCount() const = 0;
 
 virtual const CHLFileNameData* GetNthEntry(int32 nIndex) const = 0;
 
 virtual bool16 IsSpellingService(int32 nIndex) const = 0;
 
 virtual bool16 IsHyphenationService(int32 nIndex) const = 0;
 
 virtual bool16 IsThesaurusService(int32 nIndex) const = 0;
};

#endif //#ifndef __ICHLFileNameTable__


// End, ICHLFileNameTable.h.