ILinguisticMgr Class Reference

#include <ILinguisticMgr.h>

Inheritance diagram for ILinguisticMgr:

Public Types
enum	{ kDefaultIID = IID_ILINGUISTICMGR }
enum	Services { kHyphenation, kSpelling, kPhonetic, kThesaurus }

Public Member Functions
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
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
virtual uint32	GetLanguageCount () const =0
virtual ILanguage *	QueryNthLanguage (uint32 nNthLanguage)=0
virtual ILanguage *	QueryLanguage (const PMString &rLanguageName)=0
virtual IK2ServiceProvider *	QueryDefaultProvider ()=0
virtual IK2ServiceProvider *	QueryProviderByClassID (ClassID nClass)=0
virtual bool16	GetLanguageName (LanguageID nLanguage, PMString *pName, PMString *pPrimaryName=nil, PMString *pSubName=nil) const =0
virtual ILanguage *	QueryLanguageByID (LanguageID nLanguageID)=0
virtual int32	GetProviderCount () const =0
virtual IK2ServiceProvider *	QueryNthProvider (int32 nService)=0
virtual IK2ServiceProvider *	QueryDefaultService (ILinguisticMgr::Services nWhich, const ILanguage *pLanguage)=0
virtual IK2ServiceProvider *	QueryNthService (ILinguisticMgr::Services nWhich, const ILanguage *pLanguage, uint32 nNthService)=0
virtual bool16	SetDefaultService (ILinguisticMgr::Services nWhich, const ILanguage *pLanguage, const IK2ServiceProvider *pProvider)=0
virtual uint32	GetServiceCount (ILinguisticMgr::Services nWhich, const ILanguage *pLanguage) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

The LinguisticMgr is able to support many Linguistic systems (like Proximity and Info) at the same time. A Linguistic System contains a set of services: hyphenation, spelling, thesaurus and user dictionaries. To be able to mix the Linguistic Systems you should ask the LinguisticMgr for a particular service with a language specification. The connections between a language and a service will be administrated in the workspace of the application.

Member Function Documentation

virtual uint32 ILinguisticMgr::GetLanguageCount ( ) const

pure virtual

Get count of languages in session ILanguageList

Returns

int32 count of languages

virtual bool16 ILinguisticMgr::GetLanguageName ( LanguageID  nLanguage, PMString *  pName, PMString *  pPrimaryName = nil, PMString *  pSubName = nil  ) const

pure virtual

Fills pName with the name that uses the languageid according to a hard coded list of names.

NOT RECOMMENDED - there can be multiple unique language names with the same language id Use name as unique identifier not languageid. Language IDs will hopefully be deprecated in the future and only name will be used.

Parameters

nLanguageID	corresponds to ILanguage::GetLanguageID()
pName	language name. corresponds to ILanguage::GetLanguageName()
pPrimaryName	primary language name. corresponds to ILanguage::GetPrimaryLanguageName()
pSubName	sub language name. corresponds to ILanguage::GetSubLanguageName()

Returns

bool16 false if unknown.

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

pure virtual

Get count of services for a language

Parameters

nWhich	which service to get a count of
pLanguage	language to get a count for

Returns

int32 count of services

virtual IK2ServiceProvider* ILinguisticMgr::QueryDefaultProvider ( )

pure virtual

Get the default linguistic provider.

Parameters

IK2ServiceProvider

linguistic provider

virtual IHyphenationService* ILinguisticMgr::QueryHyphenationService ( const ILanguage *  pLanguage, ClassID  nProvider = kDefaultLinguisticProvider  )

pure virtual

Query for the associated hyphenation service of a language If nProvider is not kDefaultLinguisticProvider this provider is preferred.

Parameters

pLanguage	language to get hyphenation service for
nProvider	If nProvider is not kDefaultLinguisticProvider this provider is preferred

Returns

IHyphenationService hyphenation service

virtual ILanguage* ILinguisticMgr::QueryLanguage ( const PMString &  rLanguageName )

pure virtual

Query for language by name in session ILanguageList

Parameters

rLanguageName

name of language. corresponds to ILanguage::GetLanguageName().

Returns

ILanguage language with name

virtual ILanguage* ILinguisticMgr::QueryLanguageByID ( LanguageID  nLanguageID )

pure virtual

Returns the installed ILanguage for the LanguageID according to a hard coded list of names.

NOT RECOMMENDED - there can be multiple unique language names with the same language id Recommend using QueryLanguage(rLanguageName). Language IDs will hopefully be deprecated in the future and only name will be used.

Parameters

nLanguageID

corresponds to ILanguage::GetLanguageID()

virtual IHyphenationService* ILinguisticMgr::QueryNthHyphenationService ( const ILanguage *  pLanguage, int32  nService, PMString *  pServiceName = nil  ) const

pure virtual

Query for nth hyphenation service for a specific language

Parameters

pLanguage	language to get hyphenation service for
nService	From 0 to < GetServicesCount
pServiceName	OUT - String to place service name into.

Returns

IHyphenationService hyphenation service

virtual ILanguage* ILinguisticMgr::QueryNthLanguage ( uint32  nNthLanguage )

pure virtual

Query for nth language in session ILanguageList

Parameters

nNthLanguage

from 0 to < GetLanguageCount()

Returns

ILanguage nth language

virtual ISpellingService* ILinguisticMgr::QueryNthSpellingService ( const ILanguage *  pLanguage, int32  nService, PMString *  pServiceName = nil  ) const

pure virtual

Query for nth spelling service for a specific language

Parameters

pLanguage	language to get spelling service for
nService	From 0 to < GetServicesCount
pServiceName	OUT - String to place service name into.

Returns

ISpellingService spelling service

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

pure virtual

Query for nth Thesaurus service for a specific language

Parameters

pLanguage	language to get Thesaurus service for
nService	From 0 to < GetServicesCount
pServiceName	OUT - String to place service name into.

Returns

IThesaurusService Thesaurus service

virtual IK2ServiceProvider* ILinguisticMgr::QueryProviderByClassID ( ClassID  nClass )

pure virtual

Returns the installed kLinguisticService for the class id.

Parameters

nClass	class id of linguistic service
IK2ServiceProvider	linguistic provider

virtual IHyphenationService* ILinguisticMgr::QuerySimpleHyphenationService ( )

pure virtual

Query for the simple hyphenation service The simple hyphenation service ranks MinTail, MinHead, hard hyphens and discretionary hyphens.

Returns

IHyphenationService hyphenation service

virtual ISpellingService* ILinguisticMgr::QuerySpellingService ( const ILanguage *  pLanguage, ClassID  nProvider = kDefaultLinguisticProvider  )

pure virtual

Query for the associated spelling service of a language If nProvider is not kDefaultLinguisticProvider this provider is preferred.

Parameters

pLanguage	language to get spelling service for
nProvider	If nProvider is not kDefaultLinguisticProvider this provider is preferred

Returns

ISpellingService spelling service

virtual IThesaurusService* ILinguisticMgr::QueryThesaurusService ( const ILanguage *  pLanguage, ClassID  nProvider = kDefaultLinguisticProvider  )

pure virtual

Query for the associated thesaurus service of a language If nProvider is not kDefaultLinguisticProvider this provider is preferred.

Parameters

pLanguage	language to get thesaurus service for
nProvider	If nProvider is not kDefaultLinguisticProvider this provider is preferred

Returns

IThesaurusService thesaurus service

virtual IUserDictService* ILinguisticMgr::QueryUserDictService ( const ILanguage *  pLanguage, ClassID  nProvider = kDefaultLinguisticProvider  )

pure virtual

Query for the associated user dictionary service of a language If nProvider is not kDefaultLinguisticProvider this provider is preferred.

Parameters

pLanguage	language to get user dictionary service for
nProvider	If nProvider is not kDefaultLinguisticProvider this provider is preferred

Returns

user dictionary service