Inheritance diagram for IDictionaryUtils:

Public Types
enum	{ kDefaultIID = IID_IDICTIONARYUTILS }

Public Member Functions
virtual bool16	GetAllUserDictsStringList (HyphenExceptionsList &list, bool16 bMerge) const =0

virtual void	CopyUserDictsToDocument (IDocument *doc) const =0

virtual bool16	CheckForAndHandleHyphConflicts (IDocument *doc, HyphenExceptionsList &heList) const =0

virtual bool16	GetProximityWord (const PMString &rNewWord, WideString pWord, HyphenPoints pPoints) const =0

virtual bool16	ImportUserDict (ILanguage pLang, IUserDict userDict, ClassID nProvider, IDFile *userDoctFile=nil, bool16 replaceOldDict=kTrue, bool16 ignoreRanking=kFalse, FuncIsWordChar isDictWordChar=nil, bool16 caseSensitive=kFalse) const =0

virtual bool16	ExportUserDict (ILanguage pLang, IUserDict userDict, ClassID nProvider, IDFile *userDoctFile=nil) const =0

virtual int32	GetNumUserDicts () const =0

virtual IScript *	QueryUserDictByName (const IScriptRequestData *data, const PMString &name) const =0

virtual IScript *	QueryUserDictByLanguageIndex (const IScriptRequestData *data, int32 n) const =0

virtual IScript *	QueryUserDictByIndex (const IScriptRequestData *data, int32 n) 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

Utilities related to dictionaries. e.g.

Utils<IDictionaryUtils>()->GetUserDictStringList( ... ) ;

Member Function Documentation

virtual bool16 IDictionaryUtils::ExportUserDict	(	ILanguage *	pLang,
		IUserDict *	userDict,
		ClassID	nProvider,
		IDFile *	userDoctFile = `nil`
	)		const

pure virtual

Exports the words of the user dictionary.

Parameters

pLang	language of user dictionary to export
userDict	user dictionary to export
nProvider	not used. send in kDefaultLinguisticProvider
userDoctFile	file to save words in. If nil then save dialog is used

virtual bool16 IDictionaryUtils::ImportUserDict	(	ILanguage *	pLang,
		IUserDict *	userDict,
		ClassID	nProvider,
		IDFile *	userDoctFile = `nil`,
		bool16	replaceOldDict = `kTrue`,
		bool16	ignoreRanking = `kFalse`,
		FuncIsWordChar	isDictWordChar = `nil`,
		bool16	caseSensitive = `kFalse`
	)		const

pure virtual

Imports the words into the user dictionary.

Parameters

pLang	language of user dictionary to import into
userDict	user dictionary to import into
nProvider	not used. send in kDefaultLinguisticProvider
userDoctFile	file to import words from. If nil then open file dialog is used. Only text files are supported.
replaceOldDict	words are removed from userDict before importing.
ignoreRanking	if kTrue then a word that matches a word already in the dictionary but has different hyphenation points will not be added to the userDict.
isDictWordChar	if nil default(PMCharFilters::SpellingIsUserDictChar) will be used.
caseSensitive	if kTrue words with different casing will be added.