offapi/com/sun/star/linguistic2/XConversionDictionaryList.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_XConversionDictionaryList_idl__
  20 #define __com_sun_star_linguistic2_XConversionDictionaryList_idl__
  21
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/container/XNameContainer.idl>
  25 #include <com/sun/star/linguistic2/XConversionDictionary.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27 #include <com/sun/star/lang/NoSupportException.idl>
  28 #include <com/sun/star/container/ElementExistException.idl>
  29
  30
  31
  32 module com { module sun { module star { module linguistic2 {
  33
  34 /** is used to manage and maintain a list of conversion dictionaries.
  35
  36     <p>The dictionaries added to the list may or may not support the
  37     com::sun::star::util::XFlushable interface.
  38     If they do those dictionaries have to be flushed upon termination
  39     of the dictionary list.</p>
  40
  41      @since OOo 1.1.2
  42 */
  43 published interface XConversionDictionaryList : com::sun::star::uno::XInterface
  44 {
  45     /**
  46         @returns
  47             the name container interface to the dictionaries in the list.
  48
  49         <p>The interface can be used to add, remove or retrieve dictionaries
  50         from the list by specifying the name of the dictionary, and
  51         (in case of inserting) the interface to the dictionary as second
  52         parameter.</p>
  53
  54         <p>A dictionary to be added must support the
  55         com::sun::star::linguistic2::XConversionDictionary
  56         interface.
  57         The dictionary to be added needs not necessarily be created by
  58         this service.</p>
  59
  60         <p>The com::sun::star::container::XNameReplace::replaceByName
  61         function is implemented empty since renaming of dictionaries
  62         is not allowed.</p>
  63     */
  64     com::sun::star::container::XNameContainer   getDictionaryContainer();
  65
  66     /** creates a new dictionary and adds it to the dictionary list.
  67
  68         <p>The dictionary will be empty and active.</p>
  69
  70         @returns
  71             an empty dictionary with the given name, locale and
  72             conversion type.
  73              `NULL` on failure.
  74
  75         @param  aName
  76             is the name of the dictionary (should be unique).
  77
  78         @param  aLocale
  79             defines the language of the dictionary.
  80
  81         @param nConversionDictionaryType
  82             One of com::sun::star::linguistic2::ConversionDictionaryType values.
  83
  84         @throws NoSupportException
  85             when <var>nConversionDictionaryType</var> is not known by the implementation.
  86
  87         @throws ElementExistException
  88             when a dictionary with the specified name already exists.
  89     */
  90     com::sun::star::linguistic2::XConversionDictionary addNewDictionary(
  91             [in] string aName,
  92             [in] com::sun::star::lang::Locale aLocale,
  93             [in] short nConversionDictionaryType )
  94         raises( com::sun::star::lang::NoSupportException,
  95                 com::sun::star::container::ElementExistException );
  96
  97     /** searches for entries that match the given text.
  98
  99         <p>All active dictionaries with matching locales and conversion
 100         type will be searched
 101         for entries matching the given text.</p>
 102
 103         <p>The exact string to be looked for is the substring from the
 104         aText parameter that starts at position nStartPos and has the
 105         length nLength.</p>
 106
 107         @returns
 108             the list of entries found. If no entry was found,
 109             it is empty.
 110
 111         @param  aText
 112             the text where the substring to be looked for will be taken from.
 113         @param  nStartPos
 114             the starting pos of the substring to be looked for.
 115         @param  nLength
 116             the length of the substring to be looked for.
 117
 118
 119         @param aLocale
 120             Locale the conversion is referred to.
 121
 122         @param nConversionDictionaryType
 123             specifies the type of conversion the dictionary
 124             can be used for. It is one of
 125             com::sun::star::linguistic2::ConversionDictionaryType.
 126
 127         @param eDirection
 128             specifies the direction of the conversion to look for.
 129             It is one of
 130             com::sun::star::linguistic2::ConversionDirection.
 131
 132         @param nTextConversionOptions
 133             Combination of com::sun::star::i18n::TextConversionOption
 134             values.
 135
 136         @throws com::sun::star::lang::IllegalArgumentException
 137             if the nTextConversionOptions parameter is invalid for
 138             the given locale.
 139
 140         @throws NoSupportException
 141             when <var>nConversionDictionaryType</var> is not known by the implementation,
 142             or when the locale is not supported (i.e. there are no dictionaries
 143             for that locale available).
 144     */
 145     sequence< string >    queryConversions(
 146             [in] string aText,
 147             [in] long nStartPos,
 148             [in] long nLength,
 149             [in] com::sun::star::lang::Locale aLocale,
 150             [in] short nConversionDictionaryType,
 151             [in] com::sun::star::linguistic2::ConversionDirection eDirection,
 152             [in] long nTextConversionOptions )
 153         raises( com::sun::star::lang::IllegalArgumentException,
 154                 com::sun::star::lang::NoSupportException );
 155
 156     /** returns the maximum number of characters used as left or right text
 157         in entries.
 158
 159         <p>All active dictionaries of the specified locale and type
 160         will be looked up to get the result.</p>
 161         <p>The parameter eDirection specifies if only the left text or the
 162         right text from entries should be considered.</p>
 163
 164         @param aLocale
 165             Locale the conversion is referred to.
 166         @param nConversionDictionaryType
 167             specifies the type of conversion dictionaries to be looked up.
 168             It is one of
 169             com::sun::star::linguistic2::ConversionDictionaryType.
 170         @param eDirection
 171             specifies if the left text or the right text of entries will
 172             be used.
 173
 174         @see com::sun::star::linguistic2::ConversionDirection
 175     */
 176     short queryMaxCharCount(
 177             [in] com::sun::star::lang::Locale aLocale,
 178             [in] short nConversionDictionaryType,
 179             [in] com::sun::star::linguistic2::ConversionDirection eDirection );
 180
 181 };
 182
 183
 184 }; }; }; };
 185
 186 #endif
 187
 188 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */