offapi/com/sun/star/linguistic2/Dictionary.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Dictionary.idl,v $
  10  * $Revision: 1.1.2.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_Dictionary_idl__
  31 #define __com_sun_star_linguistic2_Dictionary_idl__
  32
  33 #ifndef __com_sun_star_linguistic2_XDictionary_idl__
  34 #include <com/sun/star/linguistic2/XDictionary.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_linguistic2_XSearchableDictionary_idl__
  38 #include <com/sun/star/linguistic2/XSearchableDictionary.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_XFlushable_idl__
  42 #include <com/sun/star/util/XFlushable.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_frame_XStorable_idl__
  46 #include <com/sun/star/frame/XStorable.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module linguistic2 {
  52
  53 //=============================================================================
  54 /** represents a dictionary used for spell checking and hyphenation.
  55
  56
  57     @see    com::sun::star::linguistic2::DictionaryList
  58     @see    com::sun::star::linguistic2::XSearchableDictionaryList
  59
  60     @since OOo 3.0.1
  61 */
  62 service Dictionary
  63 {
  64     /** to access the dictionary functionality.
  65     */
  66     interface com::sun::star::linguistic2::XDictionary;
  67
  68     /** provide search for similar words functionality.
  69     */
  70     [optional] interface com::sun::star::linguistic2::XSearchableDictionary;
  71
  72     /** to save the dictionary content to file
  73
  74         <p>storeAsURL and storeToURL are empty implementations since the dictionaries are expected
  75         to be found in specific locations</p>
  76     */
  77     [optional] interface com::sun::star::frame::XStorable;
  78
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif