IThesaurusService Class Reference

Inheritance diagram for IThesaurusService:

Public Types
enum	{ kDefaultIID = IID_ITHESAURUSSERVICE }
enum	ThesResult { kSuccess, kFailure, kThesError }
enum	ThesWordListEnum {   kSynonyms, kAntonyms, kComparedWords, kRelatedWords,   kContrastingWords }

Public Member Functions
virtual bool16	GetThesRecord (const PMString &rWord, ThesRecord &thesRecord)=0
virtual bool16	GetSynonyms (const PMString &rWord, WideStringList &wList)=0
virtual bool16	GetAntonyms (const PMString &rWord, WideStringList &wList)=0
virtual bool16	GetNearSynonyms (const PMString &rWord, WideStringList &wList)=0
virtual bool16	GetNearAntonyms (const PMString &rWord, WideStringList &wList)=0
virtual bool16	GetSeeAlsoWords (const PMString &rWord, WideStringList &wList)=0
virtual bool16	GetAltSuggestions (const PMString &rWord, WideStringList &wList)=0
virtual bool16	Set (const PMString &rThesFileName)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Enumeration Documentation

enum IThesaurusService::ThesResult

Thesaurus results enum

enum IThesaurusService::ThesWordListEnum

Thesaurus word list types enum

Member Function Documentation

virtual bool16 IThesaurusService::GetAltSuggestions ( const PMString &  rWord, WideStringList &  wList  )

pure virtual

Get the alternate suggestions list for the lookup word, normally used if the lookup word was not found

Parameters

rWord	IN word to lookup
wList	OUT the 'alternate suggestions' wordlist.

Returns

kTrue if the list was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::GetAntonyms ( const PMString &  rWord, WideStringList &  wList  )

pure virtual

Get the antonyms list for the lookup word

Parameters

rWord	IN word to lookup
wList	OUT the 'antonyms' wordlist.

Returns

kTrue if the list was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::GetNearAntonyms ( const PMString &  rWord, WideStringList &  wList  )

pure virtual

Get the near antonyms (contrasting words) list for the lookup word

Parameters

rWord	IN word to lookup
wList	OUT the 'near antonyms' (contrasted) wordlist.

Returns

kTrue if the list was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::GetNearSynonyms ( const PMString &  rWord, WideStringList &  wList  )

pure virtual

Get the near synonyms (related words) list for the lookup word

Parameters

rWord	IN word to lookup
wList	OUT the 'near synonyms' (related) wordlist.

Returns

kTrue if the list was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::GetSeeAlsoWords ( const PMString &  rWord, WideStringList &  wList  )

pure virtual

Get the see also list for the lookup word

Parameters

rWord	IN word to lookup
wList	OUT the 'see also' (compared) wordlist.

Returns

kTrue if the list was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::GetSynonyms ( const PMString &  rWord, WideStringList &  wList  )

pure virtual

Get the synonyms list for the lookup word

Parameters

rWord	IN word to lookup
wList	OUT the 'synonyms' wordlist.

Returns

kTrue if the list was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::GetThesRecord ( const PMString &  rWord, ThesRecord &  thesRecord  )

pure virtual

Get the thesaurus record for the word

Parameters

rWord	IN word to lookup
thesRecord	OUT ThesRecord for the lookup word.

Returns

kTrue if the ThesRecord was found.

Implemented in CHLThesaurus.

virtual bool16 IThesaurusService::Set ( const PMString &  rThesFileName )

pure virtual

Set the thesaurus filename

Parameters

rThesFileName

IN filename to set

Returns

kTrue if the filename was set.

Implemented in CHLThesaurus.