ILinguisticMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __ILinguisticMgr__
#define __ILinguisticMgr__

#include "IPMUnknown.h"
#include "LanguageID.h"
#include "LinguisticID.h"


//----------------------------------------------------------------------------------------
// Interface ILinguisticMgr
//----------------------------------------------------------------------------------------
class IK2ServiceProvider;
class IHyphenationService;
class ISpellingService;
class IThesaurusService;
class IPhoneticService;
class IUserDictService;
class PMString;
class ILanguage;

#define kDefaultLinguisticProvider 0

class ILinguisticMgr : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINGUISTICMGR };
 enum Services { kHyphenation, kSpelling, kPhonetic, kThesaurus };
 

 //---------SERVICE QUERY ROUTINES-----------------

 virtual IHyphenationService * QuerySimpleHyphenationService() = 0;

 virtual IHyphenationService * QueryHyphenationService( const ILanguage *pLanguage, ClassID nProvider = kDefaultLinguisticProvider ) = 0;

 virtual ISpellingService * QuerySpellingService( const ILanguage *pLanguage, ClassID nProvider = kDefaultLinguisticProvider ) = 0;

 virtual IThesaurusService * QueryThesaurusService( const ILanguage *pLanguage, ClassID nProvider = kDefaultLinguisticProvider ) = 0;

 virtual IUserDictService * QueryUserDictService( const ILanguage *pLanguage, ClassID nProvider = kDefaultLinguisticProvider ) = 0;


 //---------SERVICE ITERATING ROUTINES-----------------

 virtual int32 GetServicesCount(ILinguisticMgr::Services nWhich,
 const ILanguage *pLanguage) const = 0;

 virtual ISpellingService * QueryNthSpellingService( const ILanguage *pLanguage, int32 nService,
 PMString *pServiceName = nil ) const = 0;
 virtual IHyphenationService * QueryNthHyphenationService( const ILanguage *pLanguage, int32 nService,
 PMString *pServiceName = nil ) const = 0;


 virtual IThesaurusService * QueryNthThesaurusService( const ILanguage *pLanguage, int32 nService,
 PMString *pServiceName = nil ) const = 0;


 //---------LANGUAGE ITERATING ROUTINES-----------------

 virtual uint32 GetLanguageCount() const = 0;

 virtual ILanguage * QueryNthLanguage( uint32 nNthLanguage ) = 0;

 virtual ILanguage * QueryLanguage( const PMString &rLanguageName ) = 0;


 //---------LINGUISTIC SERVICE ROUTINES-----------------

 virtual IK2ServiceProvider * QueryDefaultProvider() = 0;

 virtual IK2ServiceProvider * QueryProviderByClassID( ClassID nClass ) = 0;


 //---------DISCOURAGED ROUTINES-----------------
 // These routines may be deprecated in the future.

 virtual bool16 GetLanguageName( LanguageID nLanguage, PMString *pName, PMString *pPrimaryName = nil,
 PMString *pSubName = nil ) const = 0;
 
 virtual ILanguage * QueryLanguageByID( LanguageID nLanguageID ) = 0;

 // obsolete call pServices->GetServiceProviderCount( kLinguisticService ) instead
 virtual int32 GetProviderCount() const = 0;

 // obsolete call pServices->QueryNthServiceProvider( kLinguisticService, nService ) instead
 virtual IK2ServiceProvider * QueryNthProvider( int32 nService ) = 0;

 // obsolete use ILanguage QuerySpellingService and QueryHyphenationService
 virtual IK2ServiceProvider * QueryDefaultService( ILinguisticMgr::Services nWhich, const ILanguage *pLanguage ) = 0;

 // obsolete use SERVICE QUERY ROUTINES above
 virtual IK2ServiceProvider * QueryNthService( ILinguisticMgr::Services nWhich, const ILanguage *pLanguage,
 uint32 nNthService ) = 0;

 // obsolete use ILanguage SetSpellingService and SetHyphenationService
 virtual bool16 SetDefaultService( ILinguisticMgr::Services nWhich, const ILanguage *pLanguage,
 const IK2ServiceProvider *pProvider ) = 0;

 // obsolete call GetServicesCount instead
 virtual uint32 GetServiceCount( ILinguisticMgr::Services nWhich, const ILanguage *pLanguage ) const = 0;
};


#endif