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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_linguistic2_Dictionary_idl__
  20 #define __com_sun_star_linguistic2_Dictionary_idl__
  21
  22 #include <com/sun/star/linguistic2/XDictionary.idl>
  23 #include <com/sun/star/linguistic2/XSearchableDictionary.idl>
  24 #include <com/sun/star/util/XFlushable.idl>
  25 #include <com/sun/star/frame/XStorable.idl>
  26
  27
  28 module com { module sun { module star { module linguistic2 {
  29
  30 /** represents a dictionary used for spell checking and hyphenation.
  31
  32
  33     @see    com::sun::star::linguistic2::DictionaryList
  34     @see    com::sun::star::linguistic2::XSearchableDictionaryList
  35
  36     @since OOo 3.0.1
  37 */
  38 service Dictionary
  39 {
  40     /** to access the dictionary functionality.
  41     */
  42     interface com::sun::star::linguistic2::XDictionary;
  43
  44     /** provide search for similar words functionality.
  45     */
  46     [optional] interface com::sun::star::linguistic2::XSearchableDictionary;
  47
  48     /** to save the dictionary content to file
  49
  50         <p>storeAsURL and storeToURL are empty implementations since the dictionaries are expected
  51         to be found in specific locations</p>
  52     */
  53     [optional] interface com::sun::star::frame::XStorable;
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */