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