win/include/editor/nsIEditorSpellCheck.h - chromium/deps/xulrunner-sdk - Git at Google

 /*
  * DO NOT EDIT.  THIS FILE IS GENERATED FROM e:/builds/tinderbox/XR-Trunk/WINNT_5.2_Depend/mozilla/editor/idl/nsIEditorSpellCheck.idl
  */

 #ifndef __gen_nsIEditorSpellCheck_h__
 #define __gen_nsIEditorSpellCheck_h__


 #ifndef __gen_nsISupports_h__
 #include "nsISupports.h"
 #endif

 /* For IDL files that don't want to include root IDL files. */
 #ifndef NS_NO_VTABLE
 #define NS_NO_VTABLE
 #endif
 class nsIEditor; /* forward declaration */

 class nsITextServicesFilter; /* forward declaration */


 /* starting interface:    nsIEditorSpellCheck */
 #define NS_IEDITORSPELLCHECK_IID_STR "90c93610-c116-44ab-9793-62dccb9f43ce"

 #define NS_IEDITORSPELLCHECK_IID \
   {0x90c93610, 0xc116, 0x44ab, \
     { 0x97, 0x93, 0x62, 0xdc, 0xcb, 0x9f, 0x43, 0xce }}

 class NS_NO_VTABLE NS_SCRIPTABLE nsIEditorSpellCheck : public nsISupports {
  public:

   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IEDITORSPELLCHECK_IID)

   /**
    * Returns true if we can enable spellchecking. If there are no available
    * dictionaries, this will return false.
    */
   /* boolean canSpellCheck (); */
   NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval) = 0;

   /**
    * Turns on the spell checker for the given editor. enableSelectionChecking
    * set means that we only want to check the current selection in the editor,
    * (this controls the behavior of GetNextMisspelledWord). For spellchecking
    * clients with no modal UI (such as inline spellcheckers), this flag doesn't
    * matter
    */
   /* void InitSpellChecker (in nsIEditor editor, in boolean enableSelectionChecking); */
   NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking) = 0;

   /**
    * When interactively spell checking the document, this will return the
    * value of the next word that is misspelled. This also computes the
    * suggestions which you can get by calling GetSuggestedWord.
    *
    * @see nsISpellChecker::GetNextMisspelledWord
    */
   /* wstring GetNextMisspelledWord (); */
   NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval) = 0;

   /**
    * Used to get suggestions for the last word that was checked and found to
    * be misspelled. The first call will give you the first (best) suggestion.
    * Subsequent calls will iterate through all the suggestions, allowing you
    * to build a list. When there are no more suggestions, an empty string
    * (not a null pointer) will be returned.
    *
    * @see nsISpellChecker::GetSuggestedWord
    */
   /* wstring GetSuggestedWord (); */
   NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval) = 0;

   /**
    * Check a given word. In spite of the name, this function checks the word
    * you give it, returning true if the word is misspelled. If the word is
    * misspelled, it will compute the suggestions which you can get from
    * GetSuggestedWord().
    *
    * @see nsISpellChecker::CheckCurrentWord
    */
   /* boolean CheckCurrentWord (in wstring suggestedWord); */
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar *suggestedWord, PRBool *_retval) = 0;

   /**
    * Use when modally checking the document to replace a word.
    *
    * @see nsISpellChecker::CheckCurrentWord
    */
   /* void ReplaceWord (in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences); */
   NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar *misspelledWord, const PRUnichar *replaceWord, PRBool allOccurrences) = 0;

   /**
    * @see nsISpellChecker::IgnoreAll
    */
   /* void IgnoreWordAllOccurrences (in wstring word); */
   NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word) = 0;

   /**
    * Fills an internal list of words added to the personal dictionary. These
    * words can be retrieved using GetPersonalDictionaryWord()
    *
    * @see nsISpellChecker::GetPersonalDictionary
    * @see GetPersonalDictionaryWord
    */
   /* void GetPersonalDictionary (); */
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void) = 0;

   /**
    * Used after you call GetPersonalDictionary() to iterate through all the
    * words added to the personal dictionary. Will return the empty string when
    * there are no more words.
    */
   /* wstring GetPersonalDictionaryWord (); */
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval) = 0;

   /**
    * Adds a word to the current personal dictionary.
    *
    * @see nsISpellChecker::AddWordToDictionary
    */
   /* void AddWordToDictionary (in wstring word); */
   NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word) = 0;

   /**
    * Removes a word from the current personal dictionary.
    *
    * @see nsISpellChecker::RemoveWordFromPersonalDictionary
    */
   /* void RemoveWordFromDictionary (in wstring word); */
   NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word) = 0;

   /**
    * Retrieves a list of the currently available dictionaries. The strings will
    * typically be language IDs, like "en-US".
    *
    * @see mozISpellCheckingEngine::GetDictionaryList
    */
   /* void GetDictionaryList ([array, size_is (count)] out wstring dictionaryList, out PRUint32 count); */
   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar ***dictionaryList, PRUint32 *count) = 0;

   /**
    * @see nsISpellChecker::GetCurrentDictionary
    */
   /* wstring GetCurrentDictionary (); */
   NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval) = 0;

   /**
    * @see nsISpellChecker::SetCurrentDictionary
    */
   /* void SetCurrentDictionary (in wstring dictionary); */
   NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary) = 0;

   /**
    * Call to save the currently selected dictionary as the default. The
    * function UninitSpellChecker will also do this, but that function may not
    * be called in some situations. This function allows the caller to force the
    * default right now.
    */
   /* void saveDefaultDictionary (); */
   NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void) = 0;

   /**
    * Call this to free up the spell checking object. It will also save the
    * current selected language as the default for future use.
    *
    * If you have called CanSpellCheck but not InitSpellChecker, you can still
    * call this function to clear the cached spell check object, and no
    * preference saving will happen.
    */
   /* void UninitSpellChecker (); */
   NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void) = 0;

   /**
    * Used to filter the content (for example, to skip blockquotes in email from
    * spellchecking. Call this before calling InitSpellChecker; calling it
    * after initialization will have no effect.
    *
    * @see nsITextServicesDocument::setFilter
    */
   /* void setFilter (in nsITextServicesFilter filter); */
   NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter) = 0;

   /**
    * Like CheckCurrentWord, checks the word you give it, returning true if it's
    * misspelled. This is faster than CheckCurrentWord because it does not
    * compute any suggestions.
    *
    * Watch out: this does not clear any suggestions left over from previous
    * calls to CheckCurrentWord, so there may be suggestions, but they will be
    * invalid.
    */
   /* boolean CheckCurrentWordNoSuggest (in wstring suggestedWord); */
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar *suggestedWord, PRBool *_retval) = 0;

 };

   NS_DEFINE_STATIC_IID_ACCESSOR(nsIEditorSpellCheck, NS_IEDITORSPELLCHECK_IID)

 /* Use this macro when declaring classes that implement this interface. */
 #define NS_DECL_NSIEDITORSPELLCHECK \
   NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval); \
   NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking); \
   NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval); \
   NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval); \
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar *suggestedWord, PRBool *_retval); \
   NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar *misspelledWord, const PRUnichar *replaceWord, PRBool allOccurrences); \
   NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word); \
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void); \
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval); \
   NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word); \
   NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word); \
   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar ***dictionaryList, PRUint32 *count); \
   NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval); \
   NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary); \
   NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void); \
   NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void); \
   NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter); \
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar *suggestedWord, PRBool *_retval);

 /* Use this macro to declare functions that forward the behavior of this interface to another object. */
 #define NS_FORWARD_NSIEDITORSPELLCHECK(_to) \
   NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval) { return _to CanSpellCheck(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking) { return _to InitSpellChecker(editor, enableSelectionChecking); } \
   NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval) { return _to GetNextMisspelledWord(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval) { return _to GetSuggestedWord(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar *suggestedWord, PRBool *_retval) { return _to CheckCurrentWord(suggestedWord, _retval); } \
   NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar *misspelledWord, const PRUnichar *replaceWord, PRBool allOccurrences) { return _to ReplaceWord(misspelledWord, replaceWord, allOccurrences); } \
   NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word) { return _to IgnoreWordAllOccurrences(word); } \
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void) { return _to GetPersonalDictionary(); } \
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval) { return _to GetPersonalDictionaryWord(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word) { return _to AddWordToDictionary(word); } \
   NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word) { return _to RemoveWordFromDictionary(word); } \
   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar ***dictionaryList, PRUint32 *count) { return _to GetDictionaryList(dictionaryList, count); } \
   NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval) { return _to GetCurrentDictionary(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary) { return _to SetCurrentDictionary(dictionary); } \
   NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void) { return _to SaveDefaultDictionary(); } \
   NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void) { return _to UninitSpellChecker(); } \
   NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter) { return _to SetFilter(filter); } \
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar *suggestedWord, PRBool *_retval) { return _to CheckCurrentWordNoSuggest(suggestedWord, _retval); }

 /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
 #define NS_FORWARD_SAFE_NSIEDITORSPELLCHECK(_to) \
   NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->CanSpellCheck(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking) { return !_to ? NS_ERROR_NULL_POINTER : _to->InitSpellChecker(editor, enableSelectionChecking); } \
   NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNextMisspelledWord(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSuggestedWord(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar *suggestedWord, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->CheckCurrentWord(suggestedWord, _retval); } \
   NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar *misspelledWord, const PRUnichar *replaceWord, PRBool allOccurrences) { return !_to ? NS_ERROR_NULL_POINTER : _to->ReplaceWord(misspelledWord, replaceWord, allOccurrences); } \
   NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word) { return !_to ? NS_ERROR_NULL_POINTER : _to->IgnoreWordAllOccurrences(word); } \
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPersonalDictionary(); } \
   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPersonalDictionaryWord(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word) { return !_to ? NS_ERROR_NULL_POINTER : _to->AddWordToDictionary(word); } \
   NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word) { return !_to ? NS_ERROR_NULL_POINTER : _to->RemoveWordFromDictionary(word); } \
   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar ***dictionaryList, PRUint32 *count) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDictionaryList(dictionaryList, count); } \
   NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCurrentDictionary(_retval); } \
   NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCurrentDictionary(dictionary); } \
   NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->SaveDefaultDictionary(); } \
   NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->UninitSpellChecker(); } \
   NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFilter(filter); } \
   NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar *suggestedWord, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->CheckCurrentWordNoSuggest(suggestedWord, _retval); }

 #if 0
 /* Use the code below as a template for the implementation class for this interface. */

 /* Header file */
 class nsEditorSpellCheck : public nsIEditorSpellCheck
 {
 public:
   NS_DECL_ISUPPORTS
   NS_DECL_NSIEDITORSPELLCHECK

   nsEditorSpellCheck();

 private:
   ~nsEditorSpellCheck();

 protected:
   /* additional members */
 };

 /* Implementation file */
 NS_IMPL_ISUPPORTS1(nsEditorSpellCheck, nsIEditorSpellCheck)

 nsEditorSpellCheck::nsEditorSpellCheck()
 {
   /* member initializers and constructor code */
 }

 nsEditorSpellCheck::~nsEditorSpellCheck()
 {
   /* destructor code */
 }

 /* boolean canSpellCheck (); */
 NS_IMETHODIMP nsEditorSpellCheck::CanSpellCheck(PRBool *_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void InitSpellChecker (in nsIEditor editor, in boolean enableSelectionChecking); */
 NS_IMETHODIMP nsEditorSpellCheck::InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* wstring GetNextMisspelledWord (); */
 NS_IMETHODIMP nsEditorSpellCheck::GetNextMisspelledWord(PRUnichar **_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* wstring GetSuggestedWord (); */
 NS_IMETHODIMP nsEditorSpellCheck::GetSuggestedWord(PRUnichar **_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* boolean CheckCurrentWord (in wstring suggestedWord); */
 NS_IMETHODIMP nsEditorSpellCheck::CheckCurrentWord(const PRUnichar *suggestedWord, PRBool *_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void ReplaceWord (in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences); */
 NS_IMETHODIMP nsEditorSpellCheck::ReplaceWord(const PRUnichar *misspelledWord, const PRUnichar *replaceWord, PRBool allOccurrences)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void IgnoreWordAllOccurrences (in wstring word); */
 NS_IMETHODIMP nsEditorSpellCheck::IgnoreWordAllOccurrences(const PRUnichar *word)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void GetPersonalDictionary (); */
 NS_IMETHODIMP nsEditorSpellCheck::GetPersonalDictionary()
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* wstring GetPersonalDictionaryWord (); */
 NS_IMETHODIMP nsEditorSpellCheck::GetPersonalDictionaryWord(PRUnichar **_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void AddWordToDictionary (in wstring word); */
 NS_IMETHODIMP nsEditorSpellCheck::AddWordToDictionary(const PRUnichar *word)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void RemoveWordFromDictionary (in wstring word); */
 NS_IMETHODIMP nsEditorSpellCheck::RemoveWordFromDictionary(const PRUnichar *word)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void GetDictionaryList ([array, size_is (count)] out wstring dictionaryList, out PRUint32 count); */
 NS_IMETHODIMP nsEditorSpellCheck::GetDictionaryList(PRUnichar ***dictionaryList, PRUint32 *count)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* wstring GetCurrentDictionary (); */
 NS_IMETHODIMP nsEditorSpellCheck::GetCurrentDictionary(PRUnichar **_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void SetCurrentDictionary (in wstring dictionary); */
 NS_IMETHODIMP nsEditorSpellCheck::SetCurrentDictionary(const PRUnichar *dictionary)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void saveDefaultDictionary (); */
 NS_IMETHODIMP nsEditorSpellCheck::SaveDefaultDictionary()
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void UninitSpellChecker (); */
 NS_IMETHODIMP nsEditorSpellCheck::UninitSpellChecker()
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* void setFilter (in nsITextServicesFilter filter); */
 NS_IMETHODIMP nsEditorSpellCheck::SetFilter(nsITextServicesFilter *filter)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* boolean CheckCurrentWordNoSuggest (in wstring suggestedWord); */
 NS_IMETHODIMP nsEditorSpellCheck::CheckCurrentWordNoSuggest(const PRUnichar *suggestedWord, PRBool *_retval)
 {
     return NS_ERROR_NOT_IMPLEMENTED;
 }

 /* End of implementation class template. */
 #endif


 #endif /* __gen_nsIEditorSpellCheck_h__ */
	/*
	* DO NOT EDIT. THIS FILE IS GENERATED FROM e:/builds/tinderbox/XR-Trunk/WINNT_5.2_Depend/mozilla/editor/idl/nsIEditorSpellCheck.idl
	*/

	#ifndef __gen_nsIEditorSpellCheck_h__
	#define __gen_nsIEditorSpellCheck_h__


	#ifndef __gen_nsISupports_h__
	#include "nsISupports.h"
	#endif

	/* For IDL files that don't want to include root IDL files. */
	#ifndef NS_NO_VTABLE
	#define NS_NO_VTABLE
	#endif
	class nsIEditor; /* forward declaration */

	class nsITextServicesFilter; /* forward declaration */


	/* starting interface: nsIEditorSpellCheck */
	#define NS_IEDITORSPELLCHECK_IID_STR "90c93610-c116-44ab-9793-62dccb9f43ce"

	#define NS_IEDITORSPELLCHECK_IID \
	{0x90c93610, 0xc116, 0x44ab, \
	{ 0x97, 0x93, 0x62, 0xdc, 0xcb, 0x9f, 0x43, 0xce }}

	class NS_NO_VTABLE NS_SCRIPTABLE nsIEditorSpellCheck : public nsISupports {
	public:

	NS_DECLARE_STATIC_IID_ACCESSOR(NS_IEDITORSPELLCHECK_IID)

	/**
	* Returns true if we can enable spellchecking. If there are no available
	* dictionaries, this will return false.
	*/
	/* boolean canSpellCheck (); */
	NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval) = 0;

	/**
	* Turns on the spell checker for the given editor. enableSelectionChecking
	* set means that we only want to check the current selection in the editor,
	* (this controls the behavior of GetNextMisspelledWord). For spellchecking
	* clients with no modal UI (such as inline spellcheckers), this flag doesn't
	* matter
	*/
	/* void InitSpellChecker (in nsIEditor editor, in boolean enableSelectionChecking); */
	NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking) = 0;

	/**
	* When interactively spell checking the document, this will return the
	* value of the next word that is misspelled. This also computes the
	* suggestions which you can get by calling GetSuggestedWord.
	*
	* @see nsISpellChecker::GetNextMisspelledWord
	*/
	/* wstring GetNextMisspelledWord (); */
	NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval) = 0;

	/**
	* Used to get suggestions for the last word that was checked and found to
	* be misspelled. The first call will give you the first (best) suggestion.
	* Subsequent calls will iterate through all the suggestions, allowing you
	* to build a list. When there are no more suggestions, an empty string
	* (not a null pointer) will be returned.
	*
	* @see nsISpellChecker::GetSuggestedWord
	*/
	/* wstring GetSuggestedWord (); */
	NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval) = 0;

	/**
	* Check a given word. In spite of the name, this function checks the word
	* you give it, returning true if the word is misspelled. If the word is
	* misspelled, it will compute the suggestions which you can get from
	* GetSuggestedWord().
	*
	* @see nsISpellChecker::CheckCurrentWord
	*/
	/* boolean CheckCurrentWord (in wstring suggestedWord); */
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar suggestedWord, PRBool _retval) = 0;

	/**
	* Use when modally checking the document to replace a word.
	*
	* @see nsISpellChecker::CheckCurrentWord
	*/
	/* void ReplaceWord (in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences); */
	NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar misspelledWord, const PRUnichar replaceWord, PRBool allOccurrences) = 0;

	/**
	* @see nsISpellChecker::IgnoreAll
	*/
	/* void IgnoreWordAllOccurrences (in wstring word); */
	NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word) = 0;

	/**
	* Fills an internal list of words added to the personal dictionary. These
	* words can be retrieved using GetPersonalDictionaryWord()
	*
	* @see nsISpellChecker::GetPersonalDictionary
	* @see GetPersonalDictionaryWord
	*/
	/* void GetPersonalDictionary (); */
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void) = 0;

	/**
	* Used after you call GetPersonalDictionary() to iterate through all the
	* words added to the personal dictionary. Will return the empty string when
	* there are no more words.
	*/
	/* wstring GetPersonalDictionaryWord (); */
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval) = 0;

	/**
	* Adds a word to the current personal dictionary.
	*
	* @see nsISpellChecker::AddWordToDictionary
	*/
	/* void AddWordToDictionary (in wstring word); */
	NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word) = 0;

	/**
	* Removes a word from the current personal dictionary.
	*
	* @see nsISpellChecker::RemoveWordFromPersonalDictionary
	*/
	/* void RemoveWordFromDictionary (in wstring word); */
	NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word) = 0;

	/**
	* Retrieves a list of the currently available dictionaries. The strings will
	* typically be language IDs, like "en-US".
	*
	* @see mozISpellCheckingEngine::GetDictionaryList
	*/
	/* void GetDictionaryList ([array, size_is (count)] out wstring dictionaryList, out PRUint32 count); */
	NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar **dictionaryList, PRUint32 count) = 0;

	/**
	* @see nsISpellChecker::GetCurrentDictionary
	*/
	/* wstring GetCurrentDictionary (); */
	NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval) = 0;

	/**
	* @see nsISpellChecker::SetCurrentDictionary
	*/
	/* void SetCurrentDictionary (in wstring dictionary); */
	NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary) = 0;

	/**
	* Call to save the currently selected dictionary as the default. The
	* function UninitSpellChecker will also do this, but that function may not
	* be called in some situations. This function allows the caller to force the
	* default right now.
	*/
	/* void saveDefaultDictionary (); */
	NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void) = 0;

	/**
	* Call this to free up the spell checking object. It will also save the
	* current selected language as the default for future use.
	*
	* If you have called CanSpellCheck but not InitSpellChecker, you can still
	* call this function to clear the cached spell check object, and no
	* preference saving will happen.
	*/
	/* void UninitSpellChecker (); */
	NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void) = 0;

	/**
	* Used to filter the content (for example, to skip blockquotes in email from
	* spellchecking. Call this before calling InitSpellChecker; calling it
	* after initialization will have no effect.
	*
	* @see nsITextServicesDocument::setFilter
	*/
	/* void setFilter (in nsITextServicesFilter filter); */
	NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter) = 0;

	/**
	* Like CheckCurrentWord, checks the word you give it, returning true if it's
	* misspelled. This is faster than CheckCurrentWord because it does not
	* compute any suggestions.
	*
	* Watch out: this does not clear any suggestions left over from previous
	* calls to CheckCurrentWord, so there may be suggestions, but they will be
	* invalid.
	*/
	/* boolean CheckCurrentWordNoSuggest (in wstring suggestedWord); */
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar suggestedWord, PRBool _retval) = 0;

	};

	NS_DEFINE_STATIC_IID_ACCESSOR(nsIEditorSpellCheck, NS_IEDITORSPELLCHECK_IID)

	/* Use this macro when declaring classes that implement this interface. */
	#define NS_DECL_NSIEDITORSPELLCHECK \
	NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval); \
	NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking); \
	NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval); \
	NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval); \
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar suggestedWord, PRBool _retval); \
	NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar misspelledWord, const PRUnichar replaceWord, PRBool allOccurrences); \
	NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word); \
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void); \
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval); \
	NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word); \
	NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word); \
	NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar **dictionaryList, PRUint32 count); \
	NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval); \
	NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary); \
	NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void); \
	NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void); \
	NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter); \
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar suggestedWord, PRBool _retval);

	/* Use this macro to declare functions that forward the behavior of this interface to another object. */
	#define NS_FORWARD_NSIEDITORSPELLCHECK(_to) \
	NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval) { return _to CanSpellCheck(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking) { return _to InitSpellChecker(editor, enableSelectionChecking); } \
	NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval) { return _to GetNextMisspelledWord(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval) { return _to GetSuggestedWord(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar suggestedWord, PRBool _retval) { return _to CheckCurrentWord(suggestedWord, _retval); } \
	NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar misspelledWord, const PRUnichar replaceWord, PRBool allOccurrences) { return _to ReplaceWord(misspelledWord, replaceWord, allOccurrences); } \
	NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word) { return _to IgnoreWordAllOccurrences(word); } \
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void) { return _to GetPersonalDictionary(); } \
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval) { return _to GetPersonalDictionaryWord(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word) { return _to AddWordToDictionary(word); } \
	NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word) { return _to RemoveWordFromDictionary(word); } \
	NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar **dictionaryList, PRUint32 count) { return _to GetDictionaryList(dictionaryList, count); } \
	NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval) { return _to GetCurrentDictionary(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary) { return _to SetCurrentDictionary(dictionary); } \
	NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void) { return _to SaveDefaultDictionary(); } \
	NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void) { return _to UninitSpellChecker(); } \
	NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter) { return _to SetFilter(filter); } \
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar suggestedWord, PRBool _retval) { return _to CheckCurrentWordNoSuggest(suggestedWord, _retval); }

	/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
	#define NS_FORWARD_SAFE_NSIEDITORSPELLCHECK(_to) \
	NS_SCRIPTABLE NS_IMETHOD CanSpellCheck(PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->CanSpellCheck(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking) { return !_to ? NS_ERROR_NULL_POINTER : _to->InitSpellChecker(editor, enableSelectionChecking); } \
	NS_SCRIPTABLE NS_IMETHOD GetNextMisspelledWord(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNextMisspelledWord(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD GetSuggestedWord(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSuggestedWord(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWord(const PRUnichar suggestedWord, PRBool _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->CheckCurrentWord(suggestedWord, _retval); } \
	NS_SCRIPTABLE NS_IMETHOD ReplaceWord(const PRUnichar misspelledWord, const PRUnichar replaceWord, PRBool allOccurrences) { return !_to ? NS_ERROR_NULL_POINTER : _to->ReplaceWord(misspelledWord, replaceWord, allOccurrences); } \
	NS_SCRIPTABLE NS_IMETHOD IgnoreWordAllOccurrences(const PRUnichar *word) { return !_to ? NS_ERROR_NULL_POINTER : _to->IgnoreWordAllOccurrences(word); } \
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPersonalDictionary(); } \
	NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionaryWord(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPersonalDictionaryWord(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD AddWordToDictionary(const PRUnichar *word) { return !_to ? NS_ERROR_NULL_POINTER : _to->AddWordToDictionary(word); } \
	NS_SCRIPTABLE NS_IMETHOD RemoveWordFromDictionary(const PRUnichar *word) { return !_to ? NS_ERROR_NULL_POINTER : _to->RemoveWordFromDictionary(word); } \
	NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar **dictionaryList, PRUint32 count) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDictionaryList(dictionaryList, count); } \
	NS_SCRIPTABLE NS_IMETHOD GetCurrentDictionary(PRUnichar **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCurrentDictionary(_retval); } \
	NS_SCRIPTABLE NS_IMETHOD SetCurrentDictionary(const PRUnichar *dictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCurrentDictionary(dictionary); } \
	NS_SCRIPTABLE NS_IMETHOD SaveDefaultDictionary(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->SaveDefaultDictionary(); } \
	NS_SCRIPTABLE NS_IMETHOD UninitSpellChecker(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->UninitSpellChecker(); } \
	NS_SCRIPTABLE NS_IMETHOD SetFilter(nsITextServicesFilter *filter) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFilter(filter); } \
	NS_SCRIPTABLE NS_IMETHOD CheckCurrentWordNoSuggest(const PRUnichar suggestedWord, PRBool _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->CheckCurrentWordNoSuggest(suggestedWord, _retval); }

	#if 0
	/* Use the code below as a template for the implementation class for this interface. */

	/* Header file */
	class nsEditorSpellCheck : public nsIEditorSpellCheck
	{
	public:
	NS_DECL_ISUPPORTS
	NS_DECL_NSIEDITORSPELLCHECK

	nsEditorSpellCheck();

	private:
	~nsEditorSpellCheck();

	protected:
	/* additional members */
	};

	/* Implementation file */
	NS_IMPL_ISUPPORTS1(nsEditorSpellCheck, nsIEditorSpellCheck)

	nsEditorSpellCheck::nsEditorSpellCheck()
	{
	/* member initializers and constructor code */
	}

	nsEditorSpellCheck::~nsEditorSpellCheck()
	{
	/* destructor code */
	}

	/* boolean canSpellCheck (); */
	NS_IMETHODIMP nsEditorSpellCheck::CanSpellCheck(PRBool *_retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void InitSpellChecker (in nsIEditor editor, in boolean enableSelectionChecking); */
	NS_IMETHODIMP nsEditorSpellCheck::InitSpellChecker(nsIEditor *editor, PRBool enableSelectionChecking)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* wstring GetNextMisspelledWord (); */
	NS_IMETHODIMP nsEditorSpellCheck::GetNextMisspelledWord(PRUnichar **_retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* wstring GetSuggestedWord (); */
	NS_IMETHODIMP nsEditorSpellCheck::GetSuggestedWord(PRUnichar **_retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* boolean CheckCurrentWord (in wstring suggestedWord); */
	NS_IMETHODIMP nsEditorSpellCheck::CheckCurrentWord(const PRUnichar suggestedWord, PRBool _retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void ReplaceWord (in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences); */
	NS_IMETHODIMP nsEditorSpellCheck::ReplaceWord(const PRUnichar misspelledWord, const PRUnichar replaceWord, PRBool allOccurrences)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void IgnoreWordAllOccurrences (in wstring word); */
	NS_IMETHODIMP nsEditorSpellCheck::IgnoreWordAllOccurrences(const PRUnichar *word)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void GetPersonalDictionary (); */
	NS_IMETHODIMP nsEditorSpellCheck::GetPersonalDictionary()
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* wstring GetPersonalDictionaryWord (); */
	NS_IMETHODIMP nsEditorSpellCheck::GetPersonalDictionaryWord(PRUnichar **_retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void AddWordToDictionary (in wstring word); */
	NS_IMETHODIMP nsEditorSpellCheck::AddWordToDictionary(const PRUnichar *word)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void RemoveWordFromDictionary (in wstring word); */
	NS_IMETHODIMP nsEditorSpellCheck::RemoveWordFromDictionary(const PRUnichar *word)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void GetDictionaryList ([array, size_is (count)] out wstring dictionaryList, out PRUint32 count); */
	NS_IMETHODIMP nsEditorSpellCheck::GetDictionaryList(PRUnichar **dictionaryList, PRUint32 count)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* wstring GetCurrentDictionary (); */
	NS_IMETHODIMP nsEditorSpellCheck::GetCurrentDictionary(PRUnichar **_retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void SetCurrentDictionary (in wstring dictionary); */
	NS_IMETHODIMP nsEditorSpellCheck::SetCurrentDictionary(const PRUnichar *dictionary)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void saveDefaultDictionary (); */
	NS_IMETHODIMP nsEditorSpellCheck::SaveDefaultDictionary()
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void UninitSpellChecker (); */
	NS_IMETHODIMP nsEditorSpellCheck::UninitSpellChecker()
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* void setFilter (in nsITextServicesFilter filter); */
	NS_IMETHODIMP nsEditorSpellCheck::SetFilter(nsITextServicesFilter *filter)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* boolean CheckCurrentWordNoSuggest (in wstring suggestedWord); */
	NS_IMETHODIMP nsEditorSpellCheck::CheckCurrentWordNoSuggest(const PRUnichar suggestedWord, PRBool _retval)
	{
	return NS_ERROR_NOT_IMPLEMENTED;
	}

	/* End of implementation class template. */
	#endif


	#endif /* __gen_nsIEditorSpellCheck_h__ */