LCOV - code coverage report
Current view: directory - objdir/dist/include - mozISpellCheckingEngine.h (source / functions) Found Hit Coverage
Test: app.info Lines: 1 1 100.0 %
Date: 2012-06-02 Functions: 1 1 100.0 %

       1                 : /*
       2                 :  * DO NOT EDIT.  THIS FILE IS GENERATED FROM /builds/slave/m-beta-lnx-codecoverage/build/extensions/spellcheck/idl/mozISpellCheckingEngine.idl
       3                 :  */
       4                 : 
       5                 : #ifndef __gen_mozISpellCheckingEngine_h__
       6                 : #define __gen_mozISpellCheckingEngine_h__
       7                 : 
       8                 : 
       9                 : #ifndef __gen_nsISupports_h__
      10                 : #include "nsISupports.h"
      11                 : #endif
      12                 : 
      13                 : /* For IDL files that don't want to include root IDL files. */
      14                 : #ifndef NS_NO_VTABLE
      15                 : #define NS_NO_VTABLE
      16                 : #endif
      17                 : class nsIFile; /* forward declaration */
      18                 : 
      19                 : class mozIPersonalDictionary; /* forward declaration */
      20                 : 
      21                 : 
      22                 : /* starting interface:    mozISpellCheckingEngine */
      23                 : #define MOZISPELLCHECKINGENGINE_IID_STR "8ba643a4-7ddc-4662-b976-7ec123843f10"
      24                 : 
      25                 : #define MOZISPELLCHECKINGENGINE_IID \
      26                 :   {0x8ba643a4, 0x7ddc, 0x4662, \
      27                 :     { 0xb9, 0x76, 0x7e, 0xc1, 0x23, 0x84, 0x3f, 0x10 }}
      28                 : 
      29               1 : class NS_NO_VTABLE NS_SCRIPTABLE mozISpellCheckingEngine : public nsISupports {
      30                 :  public: 
      31                 : 
      32                 :   NS_DECLARE_STATIC_IID_ACCESSOR(MOZISPELLCHECKINGENGINE_IID)
      33                 : 
      34                 :   /* attribute wstring dictionary; */
      35                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionary(PRUnichar * *aDictionary) = 0;
      36                 :   NS_SCRIPTABLE NS_IMETHOD SetDictionary(const PRUnichar * aDictionary) = 0;
      37                 : 
      38                 :   /* readonly attribute wstring language; */
      39                 :   NS_SCRIPTABLE NS_IMETHOD GetLanguage(PRUnichar * *aLanguage) = 0;
      40                 : 
      41                 :   /* readonly attribute boolean providesPersonalDictionary; */
      42                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) = 0;
      43                 : 
      44                 :   /* readonly attribute boolean providesWordUtils; */
      45                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) = 0;
      46                 : 
      47                 :   /* readonly attribute wstring name; */
      48                 :   NS_SCRIPTABLE NS_IMETHOD GetName(PRUnichar * *aName) = 0;
      49                 : 
      50                 :   /* readonly attribute wstring copyright; */
      51                 :   NS_SCRIPTABLE NS_IMETHOD GetCopyright(PRUnichar * *aCopyright) = 0;
      52                 : 
      53                 :   /* attribute mozIPersonalDictionary personalDictionary; */
      54                 :   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) = 0;
      55                 :   NS_SCRIPTABLE NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) = 0;
      56                 : 
      57                 :   /* void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out PRUint32 count); */
      58                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar * **dictionaries NS_OUTPARAM, PRUint32 *count NS_OUTPARAM) = 0;
      59                 : 
      60                 :   /* boolean check (in wstring word); */
      61                 :   NS_SCRIPTABLE NS_IMETHOD Check(const PRUnichar * word, bool *_retval NS_OUTPARAM) = 0;
      62                 : 
      63                 :   /* void suggest (in wstring word, [array, size_is (count)] out wstring suggestions, out PRUint32 count); */
      64                 :   NS_SCRIPTABLE NS_IMETHOD Suggest(const PRUnichar * word, PRUnichar * **suggestions NS_OUTPARAM, PRUint32 *count NS_OUTPARAM) = 0;
      65                 : 
      66                 :   /* void loadDictionariesFromDir (in nsIFile dir); */
      67                 :   NS_SCRIPTABLE NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) = 0;
      68                 : 
      69                 :   /* void addDirectory (in nsIFile dir); */
      70                 :   NS_SCRIPTABLE NS_IMETHOD AddDirectory(nsIFile *dir) = 0;
      71                 : 
      72                 :   /* void removeDirectory (in nsIFile dir); */
      73                 :   NS_SCRIPTABLE NS_IMETHOD RemoveDirectory(nsIFile *dir) = 0;
      74                 : 
      75                 : };
      76                 : 
      77                 :   NS_DEFINE_STATIC_IID_ACCESSOR(mozISpellCheckingEngine, MOZISPELLCHECKINGENGINE_IID)
      78                 : 
      79                 : /* Use this macro when declaring classes that implement this interface. */
      80                 : #define NS_DECL_MOZISPELLCHECKINGENGINE \
      81                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionary(PRUnichar * *aDictionary); \
      82                 :   NS_SCRIPTABLE NS_IMETHOD SetDictionary(const PRUnichar * aDictionary); \
      83                 :   NS_SCRIPTABLE NS_IMETHOD GetLanguage(PRUnichar * *aLanguage); \
      84                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary); \
      85                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils); \
      86                 :   NS_SCRIPTABLE NS_IMETHOD GetName(PRUnichar * *aName); \
      87                 :   NS_SCRIPTABLE NS_IMETHOD GetCopyright(PRUnichar * *aCopyright); \
      88                 :   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary); \
      89                 :   NS_SCRIPTABLE NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary); \
      90                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar * **dictionaries NS_OUTPARAM, PRUint32 *count NS_OUTPARAM); \
      91                 :   NS_SCRIPTABLE NS_IMETHOD Check(const PRUnichar * word, bool *_retval NS_OUTPARAM); \
      92                 :   NS_SCRIPTABLE NS_IMETHOD Suggest(const PRUnichar * word, PRUnichar * **suggestions NS_OUTPARAM, PRUint32 *count NS_OUTPARAM); \
      93                 :   NS_SCRIPTABLE NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir); \
      94                 :   NS_SCRIPTABLE NS_IMETHOD AddDirectory(nsIFile *dir); \
      95                 :   NS_SCRIPTABLE NS_IMETHOD RemoveDirectory(nsIFile *dir); 
      96                 : 
      97                 : /* Use this macro to declare functions that forward the behavior of this interface to another object. */
      98                 : #define NS_FORWARD_MOZISPELLCHECKINGENGINE(_to) \
      99                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionary(PRUnichar * *aDictionary) { return _to GetDictionary(aDictionary); } \
     100                 :   NS_SCRIPTABLE NS_IMETHOD SetDictionary(const PRUnichar * aDictionary) { return _to SetDictionary(aDictionary); } \
     101                 :   NS_SCRIPTABLE NS_IMETHOD GetLanguage(PRUnichar * *aLanguage) { return _to GetLanguage(aLanguage); } \
     102                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) { return _to GetProvidesPersonalDictionary(aProvidesPersonalDictionary); } \
     103                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) { return _to GetProvidesWordUtils(aProvidesWordUtils); } \
     104                 :   NS_SCRIPTABLE NS_IMETHOD GetName(PRUnichar * *aName) { return _to GetName(aName); } \
     105                 :   NS_SCRIPTABLE NS_IMETHOD GetCopyright(PRUnichar * *aCopyright) { return _to GetCopyright(aCopyright); } \
     106                 :   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) { return _to GetPersonalDictionary(aPersonalDictionary); } \
     107                 :   NS_SCRIPTABLE NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) { return _to SetPersonalDictionary(aPersonalDictionary); } \
     108                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar * **dictionaries NS_OUTPARAM, PRUint32 *count NS_OUTPARAM) { return _to GetDictionaryList(dictionaries, count); } \
     109                 :   NS_SCRIPTABLE NS_IMETHOD Check(const PRUnichar * word, bool *_retval NS_OUTPARAM) { return _to Check(word, _retval); } \
     110                 :   NS_SCRIPTABLE NS_IMETHOD Suggest(const PRUnichar * word, PRUnichar * **suggestions NS_OUTPARAM, PRUint32 *count NS_OUTPARAM) { return _to Suggest(word, suggestions, count); } \
     111                 :   NS_SCRIPTABLE NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) { return _to LoadDictionariesFromDir(dir); } \
     112                 :   NS_SCRIPTABLE NS_IMETHOD AddDirectory(nsIFile *dir) { return _to AddDirectory(dir); } \
     113                 :   NS_SCRIPTABLE NS_IMETHOD RemoveDirectory(nsIFile *dir) { return _to RemoveDirectory(dir); } 
     114                 : 
     115                 : /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
     116                 : #define NS_FORWARD_SAFE_MOZISPELLCHECKINGENGINE(_to) \
     117                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionary(PRUnichar * *aDictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDictionary(aDictionary); } \
     118                 :   NS_SCRIPTABLE NS_IMETHOD SetDictionary(const PRUnichar * aDictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetDictionary(aDictionary); } \
     119                 :   NS_SCRIPTABLE NS_IMETHOD GetLanguage(PRUnichar * *aLanguage) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLanguage(aLanguage); } \
     120                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProvidesPersonalDictionary(aProvidesPersonalDictionary); } \
     121                 :   NS_SCRIPTABLE NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProvidesWordUtils(aProvidesWordUtils); } \
     122                 :   NS_SCRIPTABLE NS_IMETHOD GetName(PRUnichar * *aName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetName(aName); } \
     123                 :   NS_SCRIPTABLE NS_IMETHOD GetCopyright(PRUnichar * *aCopyright) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCopyright(aCopyright); } \
     124                 :   NS_SCRIPTABLE NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPersonalDictionary(aPersonalDictionary); } \
     125                 :   NS_SCRIPTABLE NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetPersonalDictionary(aPersonalDictionary); } \
     126                 :   NS_SCRIPTABLE NS_IMETHOD GetDictionaryList(PRUnichar * **dictionaries NS_OUTPARAM, PRUint32 *count NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDictionaryList(dictionaries, count); } \
     127                 :   NS_SCRIPTABLE NS_IMETHOD Check(const PRUnichar * word, bool *_retval NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->Check(word, _retval); } \
     128                 :   NS_SCRIPTABLE NS_IMETHOD Suggest(const PRUnichar * word, PRUnichar * **suggestions NS_OUTPARAM, PRUint32 *count NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->Suggest(word, suggestions, count); } \
     129                 :   NS_SCRIPTABLE NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) { return !_to ? NS_ERROR_NULL_POINTER : _to->LoadDictionariesFromDir(dir); } \
     130                 :   NS_SCRIPTABLE NS_IMETHOD AddDirectory(nsIFile *dir) { return !_to ? NS_ERROR_NULL_POINTER : _to->AddDirectory(dir); } \
     131                 :   NS_SCRIPTABLE NS_IMETHOD RemoveDirectory(nsIFile *dir) { return !_to ? NS_ERROR_NULL_POINTER : _to->RemoveDirectory(dir); } 
     132                 : 
     133                 : #if 0
     134                 : /* Use the code below as a template for the implementation class for this interface. */
     135                 : 
     136                 : /* Header file */
     137                 : class _MYCLASS_ : public mozISpellCheckingEngine
     138                 : {
     139                 : public:
     140                 :   NS_DECL_ISUPPORTS
     141                 :   NS_DECL_MOZISPELLCHECKINGENGINE
     142                 : 
     143                 :   _MYCLASS_();
     144                 : 
     145                 : private:
     146                 :   ~_MYCLASS_();
     147                 : 
     148                 : protected:
     149                 :   /* additional members */
     150                 : };
     151                 : 
     152                 : /* Implementation file */
     153                 : NS_IMPL_ISUPPORTS1(_MYCLASS_, mozISpellCheckingEngine)
     154                 : 
     155                 : _MYCLASS_::_MYCLASS_()
     156                 : {
     157                 :   /* member initializers and constructor code */
     158                 : }
     159                 : 
     160                 : _MYCLASS_::~_MYCLASS_()
     161                 : {
     162                 :   /* destructor code */
     163                 : }
     164                 : 
     165                 : /* attribute wstring dictionary; */
     166                 : NS_IMETHODIMP _MYCLASS_::GetDictionary(PRUnichar * *aDictionary)
     167                 : {
     168                 :     return NS_ERROR_NOT_IMPLEMENTED;
     169                 : }
     170                 : NS_IMETHODIMP _MYCLASS_::SetDictionary(const PRUnichar * aDictionary)
     171                 : {
     172                 :     return NS_ERROR_NOT_IMPLEMENTED;
     173                 : }
     174                 : 
     175                 : /* readonly attribute wstring language; */
     176                 : NS_IMETHODIMP _MYCLASS_::GetLanguage(PRUnichar * *aLanguage)
     177                 : {
     178                 :     return NS_ERROR_NOT_IMPLEMENTED;
     179                 : }
     180                 : 
     181                 : /* readonly attribute boolean providesPersonalDictionary; */
     182                 : NS_IMETHODIMP _MYCLASS_::GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary)
     183                 : {
     184                 :     return NS_ERROR_NOT_IMPLEMENTED;
     185                 : }
     186                 : 
     187                 : /* readonly attribute boolean providesWordUtils; */
     188                 : NS_IMETHODIMP _MYCLASS_::GetProvidesWordUtils(bool *aProvidesWordUtils)
     189                 : {
     190                 :     return NS_ERROR_NOT_IMPLEMENTED;
     191                 : }
     192                 : 
     193                 : /* readonly attribute wstring name; */
     194                 : NS_IMETHODIMP _MYCLASS_::GetName(PRUnichar * *aName)
     195                 : {
     196                 :     return NS_ERROR_NOT_IMPLEMENTED;
     197                 : }
     198                 : 
     199                 : /* readonly attribute wstring copyright; */
     200                 : NS_IMETHODIMP _MYCLASS_::GetCopyright(PRUnichar * *aCopyright)
     201                 : {
     202                 :     return NS_ERROR_NOT_IMPLEMENTED;
     203                 : }
     204                 : 
     205                 : /* attribute mozIPersonalDictionary personalDictionary; */
     206                 : NS_IMETHODIMP _MYCLASS_::GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary)
     207                 : {
     208                 :     return NS_ERROR_NOT_IMPLEMENTED;
     209                 : }
     210                 : NS_IMETHODIMP _MYCLASS_::SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary)
     211                 : {
     212                 :     return NS_ERROR_NOT_IMPLEMENTED;
     213                 : }
     214                 : 
     215                 : /* void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out PRUint32 count); */
     216                 : NS_IMETHODIMP _MYCLASS_::GetDictionaryList(PRUnichar * **dictionaries NS_OUTPARAM, PRUint32 *count NS_OUTPARAM)
     217                 : {
     218                 :     return NS_ERROR_NOT_IMPLEMENTED;
     219                 : }
     220                 : 
     221                 : /* boolean check (in wstring word); */
     222                 : NS_IMETHODIMP _MYCLASS_::Check(const PRUnichar * word, bool *_retval NS_OUTPARAM)
     223                 : {
     224                 :     return NS_ERROR_NOT_IMPLEMENTED;
     225                 : }
     226                 : 
     227                 : /* void suggest (in wstring word, [array, size_is (count)] out wstring suggestions, out PRUint32 count); */
     228                 : NS_IMETHODIMP _MYCLASS_::Suggest(const PRUnichar * word, PRUnichar * **suggestions NS_OUTPARAM, PRUint32 *count NS_OUTPARAM)
     229                 : {
     230                 :     return NS_ERROR_NOT_IMPLEMENTED;
     231                 : }
     232                 : 
     233                 : /* void loadDictionariesFromDir (in nsIFile dir); */
     234                 : NS_IMETHODIMP _MYCLASS_::LoadDictionariesFromDir(nsIFile *dir)
     235                 : {
     236                 :     return NS_ERROR_NOT_IMPLEMENTED;
     237                 : }
     238                 : 
     239                 : /* void addDirectory (in nsIFile dir); */
     240                 : NS_IMETHODIMP _MYCLASS_::AddDirectory(nsIFile *dir)
     241                 : {
     242                 :     return NS_ERROR_NOT_IMPLEMENTED;
     243                 : }
     244                 : 
     245                 : /* void removeDirectory (in nsIFile dir); */
     246                 : NS_IMETHODIMP _MYCLASS_::RemoveDirectory(nsIFile *dir)
     247                 : {
     248                 :     return NS_ERROR_NOT_IMPLEMENTED;
     249                 : }
     250                 : 
     251                 : /* End of implementation class template. */
     252                 : #endif
     253                 : 
     254                 : #define DICTIONARY_SEARCH_DIRECTORY "DictD"
     255                 : #define DICTIONARY_SEARCH_DIRECTORY_LIST "DictDL"
     256                 : #define SPELLCHECK_DICTIONARY_UPDATE_NOTIFICATION \
     257                 :   "spellcheck-dictionary-update"
     258                 : 
     259                 : #endif /* __gen_mozISpellCheckingEngine_h__ */

Generated by: LCOV version 1.7