1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_script_XArrayWrapper_idl__
25#define __com_sun_star_script_XArrayWrapper_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32module com {  module sun {  module star { module script {
33
34//=============================================================================
35/** Allows an UNO sequence that is passed between different language
36    boundries to indicate it prefers to be represented as a multidimensional
37    array with 0 or 1 based indices. UNO does not natively represent
38    Multi-Dimensional arrays, instead a sequence can have elements that are
39    themselves sequences (an array of arrays ). <p>Some languages ( example
40    BASIC ) can natively represent both Multi-Dimentional arrays and array of
41    arrays.
42    Those languages could represent a sequence of sequences as either a
43    Multi-Dimentional array or array of arrays. This structure allows a
44    preference for a Multi-Dimensional array representation to be specified.</p>
45*/
46
47published struct ArrayWrapper
48{
49    /** Indicates whether the Array should be have 1 or 0 based indexing.
50    */
51    boolean IsZeroIndex;
52    /** Contains the Array to be passed.
53        <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>
54    */
55    any Array;
56};
57
58//=============================================================================
59
60}; }; }; };
61
62#endif
63
64
65