udkapi/com/sun/star/script/ArrayWrapper.idl

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