office-gobmx/udkapi/com/sun/star/script/ArrayWrapper.idl
Rüdiger Timm 370948e904 INTEGRATION: CWS changefileheader (1.2.74); FILE MERGED
2008/03/31 16:17:52 rt 1.2.74.1: #i87441# Change license header to LPGL v3.
2008-04-11 10:53:18 +00:00

71 lines
2.9 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ArrayWrapper.idl,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#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