/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ArrayWrapper.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: rt $ $Date: 2006-05-05 10:14:46 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_script_XArrayWrapper_idl__
#define __com_sun_star_script_XArrayWrapper_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================
module com {  module sun {  module star { module script {

//=============================================================================
/** Allows an UNO sequence that is passed between different language
    boundries to indicate it prefers to be represented as a multidimensional
    array with 0 or 1 based indices. UNO does not natively represent
    Multi-Dimensional arrays, instead a sequence can have elements that are
    themselves sequences (an array of arrays ). <p>Some languages ( example
    BASIC ) can natively represent both Multi-Dimentional arrays and array of
    arrays.
    Those languages could represent a sequence of sequences as either a
    Multi-Dimentional array or array of arrays. This structure allows a
    preference for a Multi-Dimensional array representation to be specified.</p>
*/

struct ArrayWrapper
{
    /** Indicates whether the Array should be have 1 or 0 based indexing.
    */
    boolean IsZeroIndex;
    /** Contains the Array to be passed.
        <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>
    */
    any Array;
};

//=============================================================================

}; }; }; };

#endif


