ILanguageList Class Reference

#include <ILanguageList.h>

Inheritance diagram for ILanguageList:

Public Types
enum	{ kDefaultIID = IID_ILANGUAGELIST }

Public Member Functions
virtual int32	GetLanguageCount () const =0
virtual ILanguage *	QueryNthLanguage (int32 nNthLanguage)=0
virtual ILanguage *	QueryLanguage (const PMString &rLanguageName)=0
virtual ILanguage *	QueryDefaultLanguage ()=0
virtual bool16	SetDefaultLanguage (const ILanguage *pLanguage)=0
virtual bool16	AddLanguage (UID nNewLanguage)=0
virtual bool16	RemoveLanguage (UID nNewLanguage)=0
virtual ILanguage *	QueryLanguageByID (LanguageID nLanguageID)=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 ILanguage is a persistent interface of the kLanguageBoss. It is used and referenced by the ILanguageList which is an interface of the application's and document's workspace.

Member Function Documentation

virtual bool16 ILanguageList::AddLanguage ( UID  nNewLanguage )

pure virtual

Creates a new language. It asserts and returns nil if the language already exists. Should only be called by NewLanguageCmd.

Parameters

UID	UID of new language.

Returns

bool16 kTrue if lanaguage is added

virtual int32 ILanguageList::GetLanguageCount ( ) const

pure virtual

Returns number of languages in list. For the session this is the languages that are installed. For a document it may contain languages that are not presently installed but were available before.

Returns

int32 number of languages.

virtual ILanguage* ILanguageList::QueryDefaultLanguage ( )

pure virtual

Returns the default lanuage.

Returns

ILanguage* addrefed lanaguage.

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

pure virtual

Returns language given a lanaguage name. QueryLanguage() doesn't creates a new language.

Parameters

rLanguageName

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

Returns

ILanguage* addrefed lanaguage.

virtual ILanguage* ILanguageList::QueryLanguageByID ( LanguageID  nLanguageID )

pure virtual

Returns language given a lanaguage id. Doesn't creates a new language. Recommend using QueryLanguage with name. Language IDs will hopefully be deprecated in the future and only name will be used.

Parameters

nLanguageID

id of language. Corresponds to ILanguage::GetLanguageID().

Returns

ILanguage* addrefed lanaguage.

virtual ILanguage* ILanguageList::QueryNthLanguage ( int32  nNthLanguage )

pure virtual

Returns the Nth addref'ed language.

Parameters

nNthLanguage

nth language. from 0 to < GetLanguageCount().

Returns

ILanguage* addrefed lanaguage.

virtual bool16 ILanguageList::RemoveLanguage ( UID  nNewLanguage )

pure virtual

Removes Language from list. This API is not currently used and may cause problems. DeleteLanguageCmd is not implemented.

Parameters

UID	UID of language to remove.

Returns

bool16 kTrue if lanaguage is removed

virtual bool16 ILanguageList::SetDefaultLanguage ( const ILanguage *  pLanguage )

pure virtual

Set the default language.

Parameters

pLanguage

language to set as default.

Returns

bool16 kTrue if lanaguage set. kFalse if language is already default or language is not in Language list