mail/Spell.idl

   1 /*  This file is part of gnome-spell bonobo component
   2
   3     Copyright (C) 1999, 2000 Helix Code, Inc.
   4     Authors:                 Radek Doulik <rodo@helixcode.com>
   5
   6     This library is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU Library General Public
   8     License as published by the Free Software Foundation; either
   9     version 2 of the License, or (at your option) any later version.
  10
  11     This library is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14     Library General Public License for more details.
  15
  16     You should have received a copy of the GNU Library General Public License
  17     along with this library; see the file COPYING.LIB.  If not, write to
  18     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19     Boston, MA 02111-1307, USA.
  20 */
  21
  22 #include <Bonobo.idl>
  23
  24 module GNOME {
  25         module Spell {
  26
  27                 typedef sequence<string> StringSeq;
  28                 struct Language {
  29                         string name;
  30                         string abbreviation;
  31                 };
  32                 typedef sequence<Language> LanguageSeq;
  33
  34                 interface Dictionary : Bonobo::Unknown {
  35
  36                         exception Error {
  37                                 string error;
  38                         };
  39
  40                         LanguageSeq getLanguages ();
  41
  42                         /**
  43                          * sets language(s), language string could contain more languages separated by space
  44                          */
  45                         void setLanguage (in string language);
  46
  47                         /**
  48                          * checks word
  49                          *
  50                          * returns true if word is valid
  51                          */
  52                         boolean checkWord (in string word) raises (Error);
  53
  54                         /**
  55                          * returns suggestions for word
  56                          */
  57                         StringSeq getSuggestions (in string word) raises (Error);
  58
  59                         /**
  60                          * add to session/personal dictionary
  61                          */
  62                         void addWordToSession  (in string word) raises (Error);
  63                         void addWordToPersonal (in string word, in string language) raises (Error);
  64
  65                         /**
  66                          * informs dictionary, that word 'word' will be replaced/corrected by word 'replacement'
  67                          */
  68                         void setCorrection (in string word, in string replacement, in string language);
  69                 };
  70         };
  71 };