Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

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

1 files changed, 126 insertions, 0 deletions

diff --git a/udkapi/com/sun/star/container/XStringKeyMap.idl b/udkapi/com/sun/star/container/XStringKeyMap.idl
new file mode 100644
index 000000000..47f58ebfa
--- /dev/null
+++ b/udkapi/com/sun/star/container/XStringKeyMap.idl
@@ -0,0 +1,126 @@
+/* -*- 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_container_XStringKeyMap_idl__
+#define __com_sun_star_container_XStringKeyMap_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
+#include <com/sun/star/container/ElementExistException.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/container/NoSuchElementException.idl>
+
+
+module com {  module sun {  module star {  module container {
+
+
+/** maps strings to anys.
+
+    @since OOo 2.3
+ */
+
+interface XStringKeyMap
+{
+    /** reads data from the map.
+
+        @param aKey
+                The key string which should be searched for.
+
+        @return
+                the value matching aKey.
+
+        @throws com::sun::star::container::NoSuchElementException
+                if an element under aKey does not exist.
+     */
+    any getValue( [in] string aKey )
+        raises( com::sun::star::container::NoSuchElementException );
+
+
+    /** checks for element existence.
+
+        @param aKey
+                The key string which should be searched for.
+
+        @return
+                true if an element with key aKey exists.
+     */
+    boolean hasValue( [in] string aKey );
+
+
+    /** writes data to the map.
+
+        @param aKey
+                The key string which should be used to store the value.
+
+        @param aValue
+                The value that should be stored.
+
+        @throws com::sun::star::lang::IllegalArgumentException
+                if the element could not be inserted.
+
+        @throws com::sun::star::container::ElementExistException
+                if there is already a value stored under the key aKey.
+     */
+    void insertValue( [in] string aKey, [in] any aValue )
+        raises( com::sun::star::lang::IllegalArgumentException,
+                com::sun::star::container::ElementExistException );
+
+
+    /** the number of elements in the map.
+     */
+    [attribute, readonly] long Count;
+
+
+    /** obtains the key of an element by index.
+
+        @param nIndex
+                is the index of the element.
+
+        @return
+                the key string matching the given index.
+
+        @throws com::sun::star::lang::IndexOutOfBoundsException
+                if the specified index is greater than the number of
+                elements
+     */
+    string getKeyByIndex( [in] long nIndex )
+        raises( com::sun::star::lang::IndexOutOfBoundsException );
+
+
+    /** obtains the value of an element by index.
+
+        @param nIndex
+                is the index of the key.
+
+        @return
+                the value matching the given index.
+
+        @throws com::sun::star::lang::IndexOutOfBoundsException
+                if the specified index is greater than the number of
+                elements
+     */
+    any getValueByIndex( [in] long nIndex )
+        raises( com::sun::star::lang::IndexOutOfBoundsException );
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */