Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 202 insertions, 0 deletions

diff --git a/offapi/com/sun/star/linguistic2/XConversionDictionary.idl b/offapi/com/sun/star/linguistic2/XConversionDictionary.idl
new file mode 100644
index 000000000..a20a4a613
--- /dev/null
+++ b/offapi/com/sun/star/linguistic2/XConversionDictionary.idl
@@ -0,0 +1,202 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_linguistic2_XConversionDictionary_idl__
+#define __com_sun_star_linguistic2_XConversionDictionary_idl__
+
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/lang/Locale.idl>
+#include <com/sun/star/linguistic2/ConversionDictionaryType.idl>
+#include <com/sun/star/linguistic2/ConversionDirection.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/container/ElementExistException.idl>
+#include <com/sun/star/container/NoSuchElementException.idl>
+
+
+
+module com { module sun { module star { module linguistic2 {
+
+/** Allows the user to access a conversion dictionary.
+
+    <p>The dictionary consists of entries (pairs) of the form
+    ( aLeftText, aRightText ).
+    Those pairs can be added and removed. Also it can be looked
+    for all entries where the left text or the right text matches
+    a given text. Thus it can be used for conversions in both
+    directions.</p>
+
+    <p>Restrictions to what has to be the left and right text are usually
+    given by specific services implementing this interface.</p>
+
+    @see com::sun::star::linguistic2::ConversionDictionary
+    @see com::sun::star::linguistic2::HangulHanjaConversionDictionary
+
+     @since OOo 1.1.2
+*/
+published interface XConversionDictionary : com::sun::star::uno::XInterface
+{
+    /**
+        @returns
+            the name of the dictionary.
+    */
+    string getName();
+
+    /**
+        @returns
+            the language supported by the dictionary.
+
+        @see    com::sun::star::lang::Locale
+    */
+    com::sun::star::lang::Locale getLocale();
+
+    /**
+        @returns
+            the conversion type supported by the dictionary.
+
+        @see    com::sun::star::linguistic2::ConversionDictionaryType
+    */
+    short getConversionType();
+
+    /** specifies whether the dictionary should be used or not .
+
+        @param  bActivate
+            `TRUE` if the dictionary should be used, `FALSE` otherwise.
+
+    */
+    void setActive( [in] boolean bActivate );
+
+    /**
+        @returns
+            `TRUE` if the dictionary is active, `FALSE` otherwise.
+    */
+    boolean isActive();
+
+    /** removes all entries from the dictionary.
+    */
+    void clear();
+
+    /** searches for entries or conversions that match the given text.
+
+        <p>The exact string to be looked for is the substring from the
+        aText parameter that starts at position nStartPos and has the
+        length nLength.</p>
+
+        @returns
+            the list of conversions found for the supplied text.
+            If no nothing was found, it is empty.
+
+        @param  aText
+            the text where the substring to be looked for will be taken from.
+            Depending on the conversion direction parameter it specifies
+            either the left text or the right text to look for.
+        @param  nStartPos
+            the starting pos of the substring to be looked for.
+        @param  nLength
+            the length of the substring to be looked for.
+
+        @param eDirection
+            specifies the direction of the conversion to look for.
+            It is one of
+            com::sun::star::linguistic2::ConversionDirection.
+
+        @param nTextConversionOptions
+            Combination of com::sun::star::i18n::TextConversionOption
+            values.
+
+        @throws com::sun::star::lang::IllegalArgumentException
+            if the locale is not supported by the dictionary or if
+            nTextConversionOptions is invalid for the given locale.
+    */
+    sequence< string > getConversions(
+            [in] string aText,
+            [in] long nStartPos,
+            [in] long nLength,
+            [in] com::sun::star::linguistic2::ConversionDirection eDirection,
+            [in] long nTextConversionOptions )
+        raises( com::sun::star::lang::IllegalArgumentException );
+
+    /** is used to add a conversion pair to the dictionary.
+
+        @param  aLeftText
+            the left text of the pair to be added.
+
+        @param  aRightText
+            the right text of the pair to be added.
+
+        @throws com::sun::star::lang::IllegalArgumentException
+            if the arguments are invalid.
+            For example if the specifications defined by the service
+            implementing this object are not met.
+
+        @throws com::sun::star::container::ElementExistException
+            if such an entry already exists.
+    */
+    void addEntry(
+            [in] string     aLeftText,
+            [in] string     aRightText )
+        raises( com::sun::star::lang::IllegalArgumentException,
+                com::sun::star::container::ElementExistException);
+
+    /** removes a conversion pair from the dictionary.
+
+        @param  aLeftText
+            the left text of the pair to be removed.
+
+        @param  aRightText
+            the right text of the pair to be removed.
+
+        @throws com::sun::star::container::NoSuchElementException
+            if there is no such entry.
+    */
+    void removeEntry(
+            [in] string     aLeftText,
+            [in] string     aRightText )
+        raises( com::sun::star::container::NoSuchElementException );
+
+    /** returns the maximum number of characters used as left or right text
+        in entries.
+
+        @param eDirection
+            specifies if the left text or the right text of entries will
+            be used.
+
+        @see com::sun::star::linguistic2::ConversionDirection
+    */
+    short getMaxCharCount(
+            [in] com::sun::star::linguistic2::ConversionDirection eDirection );
+
+    /**
+        @returns
+            a list of all left or right parts of the dictionaries entries.
+        @param  eDirection
+            specifies if all left or all right parts of the entries
+            should be returned.
+    */
+
+    sequence< string > getConversionEntries(
+            [in] com::sun::star::linguistic2::ConversionDirection eDirection );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */