summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/script/ArrayWrapper.idl
diff options
context:
space:
mode:
Diffstat (limited to 'udkapi/com/sun/star/script/ArrayWrapper.idl')
-rw-r--r--udkapi/com/sun/star/script/ArrayWrapper.idl56
1 files changed, 56 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/script/ArrayWrapper.idl b/udkapi/com/sun/star/script/ArrayWrapper.idl
new file mode 100644
index 000000000..b786f303c
--- /dev/null
+++ b/udkapi/com/sun/star/script/ArrayWrapper.idl
@@ -0,0 +1,56 @@
+/* -*- 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_script_ArrayWrapper_idl__
+#define __com_sun_star_script_ArrayWrapper_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+module com { module sun { module star { module script {
+
+/** Allows a UNO sequence that is passed between different language
+ boundaries to indicate it prefers to be represented as a multidimensional
+ array with 0 or 1 based indices. UNO does not natively represent
+ Multi-Dimensional arrays, instead a sequence can have elements that are
+ themselves sequences (an array of arrays ). <p>Some languages ( example
+ BASIC ) can natively represent both Multi-Dimensional arrays and array of
+ arrays.
+ Those languages could represent a sequence of sequences as either a
+ Multi-Dimensional array or array of arrays. This structure allows a
+ preference for a Multi-Dimensional array representation to be specified.</p>
+*/
+
+struct ArrayWrapper
+{
+ /** Indicates whether the Array should be have 1 or 0 based indexing.
+ */
+ boolean IsZeroIndex;
+ /** Contains the Array to be passed.
+ <p> Multi-dimensional arrays can only be represented as a sequence where the elements of the sequence are themselves sequences. N-Levels of indirection are possible, where N is the number of dimensions. Note: its perfectly legal to use this structure with a single dimensioned array just to indicate the array indexing.</p>
+ */
+ any Array;
+};
+
+
+}; }; }; };
+
+#endif
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */