xref: /trunk/main/udkapi/com/sun/star/script/ArrayWrapper.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir
28*cdf0e10cSrcweir#ifndef __com_sun_star_script_XArrayWrapper_idl__
29*cdf0e10cSrcweir#define __com_sun_star_script_XArrayWrapper_idl__
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
33*cdf0e10cSrcweir#endif
34*cdf0e10cSrcweir
35*cdf0e10cSrcweir//=============================================================================
36*cdf0e10cSrcweirmodule com {  module sun {  module star { module script {
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir//=============================================================================
39*cdf0e10cSrcweir/** Allows an UNO sequence that is passed between different language
40*cdf0e10cSrcweir    boundries to indicate it prefers to be represented as a multidimensional
41*cdf0e10cSrcweir    array with 0 or 1 based indices. UNO does not natively represent
42*cdf0e10cSrcweir    Multi-Dimensional arrays, instead a sequence can have elements that are
43*cdf0e10cSrcweir    themselves sequences (an array of arrays ). <p>Some languages ( example
44*cdf0e10cSrcweir    BASIC ) can natively represent both Multi-Dimentional arrays and array of
45*cdf0e10cSrcweir    arrays.
46*cdf0e10cSrcweir    Those languages could represent a sequence of sequences as either a
47*cdf0e10cSrcweir    Multi-Dimentional array or array of arrays. This structure allows a
48*cdf0e10cSrcweir    preference for a Multi-Dimensional array representation to be specified.</p>
49*cdf0e10cSrcweir*/
50*cdf0e10cSrcweir
51*cdf0e10cSrcweirpublished struct ArrayWrapper
52*cdf0e10cSrcweir{
53*cdf0e10cSrcweir    /** Indicates whether the Array should be have 1 or 0 based indexing.
54*cdf0e10cSrcweir    */
55*cdf0e10cSrcweir    boolean IsZeroIndex;
56*cdf0e10cSrcweir    /** Contains the Array to be passed.
57*cdf0e10cSrcweir        <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>
58*cdf0e10cSrcweir    */
59*cdf0e10cSrcweir    any Array;
60*cdf0e10cSrcweir};
61*cdf0e10cSrcweir
62*cdf0e10cSrcweir//=============================================================================
63*cdf0e10cSrcweir
64*cdf0e10cSrcweir}; }; }; };
65*cdf0e10cSrcweir
66*cdf0e10cSrcweir#endif
67*cdf0e10cSrcweir
68*cdf0e10cSrcweir
69