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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_linguistic2_ConversionDictionary_idl__
  28 #define __com_sun_star_linguistic2_ConversionDictionary_idl__
  29
  30 #ifndef __com_sun_star_linguistic2_XConversionDictionary_idl__
  31 #include <com/sun/star/linguistic2/XConversionDictionary.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_XFlushable_idl__
  35 #include <com/sun/star/util/XFlushable.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_linguistic2_XConversionPropertyType_idl__
  39 #include <com/sun/star/linguistic2/XConversionPropertyType.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module linguistic2 {
  45
  46 //=============================================================================
  47 /** represents a dictionary used in a conversion dictionary list.
  48
  49     <p>Specific implementations may put some restrictions for
  50     the dictionary or it's entries.
  51     Namely usually the order for the string pairs within a single entry
  52     will be defined.</p>
  53
  54     @see    com::sun::star::linguistic2::ConversionDictionaryList
  55     @see    com::sun::star::linguistic2::HangulHanjaConversionDictionary
  56     @see    com::sun::star::linguistic2::XConversionDictionary
  57     @see    com::sun::star::linguistic2::XConversionPropertyType
  58
  59      @since OOo 1.1.2
  60 */
  61 published service ConversionDictionary
  62 {
  63     /** to access the conversion dictionary functionality.
  64     */
  65     interface com::sun::star::linguistic2::XConversionDictionary;
  66
  67     /** to flush (save) the dictionary content to file
  68     */
  69     [optional] interface com::sun::star::util::XFlushable;
  70
  71     /**
  72         @since OOo 2.0.0
  73     */
  74     [optional] interface com::sun::star::linguistic2::XConversionPropertyType;
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif