ISpellingPrefs Class Reference

#include <ISpellingPrefs.h>

Inheritance diagram for ISpellingPrefs:

Public Types
enum	{ kDefaultIID = IID_ISPELLINGPREFS }

Public Member Functions
virtual bool16	GetDynamicSpellCheck () const =0
virtual void	SetDynamicSpellCheck (bool16 dynamicSpellCheck)=0
virtual int32	GetDynamicSpellMisspelledWordColorIndex () const =0
virtual void	SetDynamicSpellMisspelledWordColorIndex (int32 index)=0
virtual int32	GetDynamicSpellRepeatedWordColorIndex () const =0
virtual void	SetDynamicSpellRepeatedWordColorIndex (int32 index)=0
virtual int32	GetDynamicSpellUncapitalizedWordColorIndex () const =0
virtual void	SetDynamicSpellUncapitalizedWordColorIndex (int32 index)=0
virtual int32	GetDynamicSpellUncapitalizedSentenceColorIndex () const =0
virtual void	SetDynamicSpellUncapitalizedSentenceColorIndex (int32 index)=0
virtual bool16	GetCheckMisspelledWords () const =0
virtual void	SetCheckMisspelledWords (bool16 checkMisspelledWords)=0
virtual bool16	GetCheckRepeatedWords () const =0
virtual void	SetCheckRepeatedWords (bool16 checkRepeatedWords)=0
virtual bool16	GetCheckCapitalizeWords () const =0
virtual void	SetCheckCapitalizeWords (bool16 checkCapitalizeWords)=0
virtual bool16	GetCheckCapitalizeSentences () const =0
virtual void	SetCheckCapitalizeSentences (bool16 checkCapitalizeSentences)=0
virtual void	Set (bool16 dsc, int32 mwColorIndex, int32 rwColorIndex, int32 uwColorIndex, int32 usColorIndex, bool16 cmw, bool16 crw, bool16 ccw, bool16 ccs)=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

This interface is gets and sets the preferences used by the dynamic spell checking system.

See Also

kWorkspaceBoss

kSpellingPrefsCmdBoss

IUIColorUtils

Member Function Documentation

virtual bool16 ISpellingPrefs::GetCheckCapitalizeSentences ( ) const

pure virtual

GetCheckCapitalizeSentences

Returns

kTrue if dynamic spell checking is checking for uncapitalized sentences; kFalse if it is not

virtual bool16 ISpellingPrefs::GetCheckCapitalizeWords ( ) const

pure virtual

GetCheckCapitalizeWords

Returns

kTrue if dynamic spell checking is checking for uncapitalized words; kFalse if it is not

virtual bool16 ISpellingPrefs::GetCheckMisspelledWords ( ) const

pure virtual

GetCheckMisspelledWords

Returns

kTrue if dynamic spell checking is checking for misspelled words; kFalse if it is not

virtual bool16 ISpellingPrefs::GetCheckRepeatedWords ( ) const

pure virtual

GetCheckRepeatedWords

Returns

kTrue if dynamic spell checking is checking for repeated words; kFalse if it is not

virtual bool16 ISpellingPrefs::GetDynamicSpellCheck ( ) const

pure virtual

GetDynamicSpellCheck

Returns

kTrue if dynamic spell checking is on; kFalse if it is off

virtual int32 ISpellingPrefs::GetDynamicSpellMisspelledWordColorIndex ( ) const

pure virtual

GetDynamicSpellMisspelledWordColorIndex Gets the index of the UI color to be used to indicate misspelled words. This color index references the document's UI color list (which resides in the document's workspace).

Returns

The index of the color to be used

virtual int32 ISpellingPrefs::GetDynamicSpellRepeatedWordColorIndex ( ) const

pure virtual

GetDynamicSpellRepeatedWordColorIndex Gets the index of the UI color to be used to indicate repeated words. This color index references the document's UI color list (which resides in the document's workspace).

Returns

The index of the color to be used

virtual int32 ISpellingPrefs::GetDynamicSpellUncapitalizedSentenceColorIndex ( ) const

pure virtual

GetDynamicSpellUncapitalizedSentenceColorIndex Gets the index of the UI color to be used to indicate uncapitalized sentences. This color index references the document's UI color list (which resides in the document's workspace).

Returns

The index of the color to be used

virtual int32 ISpellingPrefs::GetDynamicSpellUncapitalizedWordColorIndex ( ) const

pure virtual

GetDynamicSpellUncapitalizedWordColorIndex Gets the index of the UI color to be used to indicate uncapitalized words. This color index references the document's UI color list (which resides in the document's workspace).

Returns

The index of the color to be used

virtual void ISpellingPrefs::Set ( bool16  dsc, int32  mwColorIndex, int32  rwColorIndex, int32  uwColorIndex, int32  usColorIndex, bool16  cmw, bool16  crw, bool16  ccw, bool16  ccs  )

pure virtual

Set: Sets all of the spelling preferences in one call.

Parameters

IN	dsc - kTrue == turn on dynamic spell checking; kFalse == turn off dynamic spell checking
IN	mwColorIndex - color used to mark misspelled words when dynamic spell checking is on
IN	rwColorIndex - color used to mark repeated words when dynamic spell checking is on
IN	uwColorIndex - color used to mark uncapitalized words when dynamic spell checking is on
IN	usColorIndex - color used to mark uncapitalized sentences when dynamic spell checking is on
IN	cmw - kTrue == check for misspelled words; kFalse == don't
IN	crw - kTrue == check for repeated words; kFalse == don't
IN	ccw - kTrue == check for mis-capitalized words; kFalse == don't
IN	ccs - kTrue == check for mis-capitalized sentences; kFalse == don't

virtual void ISpellingPrefs::SetCheckCapitalizeSentences ( bool16  checkCapitalizeSentences )

pure virtual

SetCheckCapitalizeSentences

Parameters

checkCapitalizeSentences,:

kTrue to turn on dynamic checking for uncapitalized sentences; kFalse to turn it off

virtual void ISpellingPrefs::SetCheckCapitalizeWords ( bool16  checkCapitalizeWords )

pure virtual

SetCheckCapitalizeWords

Parameters

checkCapitalizeWords,:

kTrue to turn on dynamic checking for uncapitalized words; kFalse to turn it off

virtual void ISpellingPrefs::SetCheckMisspelledWords ( bool16  checkMisspelledWords )

pure virtual

SetCheckMisspelledWords

Parameters

checkMisspelledWords,:

kTrue to turn on dynamic checking for misspelled words; kFalse to turn it off

virtual void ISpellingPrefs::SetCheckRepeatedWords ( bool16  checkRepeatedWords )

pure virtual

SetCheckRepeatedWords

Parameters

checkRepeatedWords,:

kTrue to turn on dynamic checking for repeated words; kFalse to turn it off

virtual void ISpellingPrefs::SetDynamicSpellCheck ( bool16  dynamicSpellCheck )

pure virtual

SetDynamicSpellcheck

Parameters

dynamicSpellcheck,:

kTrue to turn on dynamic spell checking; kFalse to turn it off

virtual void ISpellingPrefs::SetDynamicSpellMisspelledWordColorIndex ( int32  index )

pure virtual

SetDynamicSpellMisspelledWordColorIndex Sets the index of the UI color to be used to indicate misspelled words.

Parameters

index,:

index of color in the document's UI color list

virtual void ISpellingPrefs::SetDynamicSpellRepeatedWordColorIndex ( int32  index )

pure virtual

SetDynamicSpellRepeatedWordColorIndex Sets the index of the UI color to be used to indicate repeated words.

Parameters

index,:

index of color in the document's UI color list

virtual void ISpellingPrefs::SetDynamicSpellUncapitalizedSentenceColorIndex ( int32  index )

pure virtual

SetDynamicSpellUncapitalizedSentenceColorIndex Sets the index of the UI color to be used to indicate uncapitalized sentences.

Parameters

index,:

index of color in the document's UI color list

virtual void ISpellingPrefs::SetDynamicSpellUncapitalizedWordColorIndex ( int32  index )

pure virtual

SetDynamicSpellUncapitalizedWordColorIndex Sets the index of the UI color to be used to indicate uncapitalized words.

Parameters

index,:

index of color in the document's UI color list