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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_script_ArrayWrapper_idl__
  21 #define __com_sun_star_script_ArrayWrapper_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com {  module sun {  module star { module script {
  26
  27 /** Allows an UNO sequence that is passed between different language
  28     boundries to indicate it prefers to be represented as a multidimensional
  29     array with 0 or 1 based indices. UNO does not natively represent
  30     Multi-Dimensional arrays, instead a sequence can have elements that are
  31     themselves sequences (an array of arrays ). <p>Some languages ( example
  32     BASIC ) can natively represent both Multi-Dimensional arrays and array of
  33     arrays.
  34     Those languages could represent a sequence of sequences as either a
  35     Multi-Dimensional array or array of arrays. This structure allows a
  36     preference for a Multi-Dimensional array representation to be specified.</p>
  37 */
  38
  39 struct ArrayWrapper
  40 {
  41     /** Indicates whether the Array should be have 1 or 0 based indexing.
  42     */
  43     boolean IsZeroIndex;
  44     /** Contains the Array to be passed.
  45         <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>
  46     */
  47     any Array;
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */