142 lines
4.6 KiB
Text
142 lines
4.6 KiB
Text
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: XIdlArray.idl,v $
|
|
*
|
|
* $Revision: 1.12 $
|
|
*
|
|
* last change: $Author: rt $ $Date: 2005-09-09 15:58:04 $
|
|
*
|
|
* 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_reflection_XIdlArray_idl__
|
|
#define __com_sun_star_reflection_XIdlArray_idl__
|
|
|
|
#ifndef __com_sun_star_uno_XInterface_idl__
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
|
|
#include <com/sun/star/lang/IllegalArgumentException.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__
|
|
#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl>
|
|
#endif
|
|
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module reflection {
|
|
|
|
//=============================================================================
|
|
|
|
/** Reflects an IDL sequence and provides dynamic access to instances of
|
|
that sequence.
|
|
This interface supports widening conversion when getting or setting elements.
|
|
|
|
@attention
|
|
Although the name of this interface denotes arrays,
|
|
sequences are meant. Don't be obfuscated, arrays are not supported by UNO!
|
|
*/
|
|
published interface XIdlArray: com::sun::star::uno::XInterface
|
|
{
|
|
/** Rellocates the length of the sequence instance.
|
|
|
|
@param array
|
|
sequence instance
|
|
@length
|
|
new length of sequence
|
|
*/
|
|
void realloc(
|
|
[inout] any array,
|
|
[in] long length )
|
|
raises( com::sun::star::lang::IllegalArgumentException );
|
|
|
|
/** Returns the length of the given sequence.
|
|
|
|
@param array
|
|
sequence instance
|
|
@return
|
|
length of sequence
|
|
*/
|
|
long getLen( [in] any array )
|
|
raises( com::sun::star::lang::IllegalArgumentException );
|
|
|
|
/** Returns element at given index.
|
|
|
|
@param aArray
|
|
sequence instance
|
|
@param nIndex
|
|
index
|
|
@return
|
|
value
|
|
|
|
@throws IllegalArgumentException
|
|
if the specified object is not a sequence or if the specified object is null
|
|
|
|
@throws ArrayIndexOutOfBoundsException
|
|
if the specified index argument is negative, or if it is greater than or equal to the
|
|
length of the specified sequence.
|
|
*/
|
|
any get(
|
|
[in] any aArray,
|
|
[in] long nIndex )
|
|
raises( com::sun::star::lang::IllegalArgumentException,
|
|
com::sun::star::lang::ArrayIndexOutOfBoundsException );
|
|
|
|
/** Sets a new value at given index.
|
|
|
|
@param aArray
|
|
sequence instance
|
|
@param nIndex
|
|
index
|
|
@param aNewValue
|
|
new value to be set
|
|
|
|
@throws IllegalArgumentException
|
|
if the specified object is not a sequence or if the specified object is null
|
|
|
|
@throws ArrayIndexOutOfBoundsException
|
|
if the specified index argument is negative, or if it is greater than or equal to the
|
|
length of the specified sequence.
|
|
*/
|
|
void set(
|
|
[inout] any aArray,
|
|
[in] long nIndex,
|
|
[in] any aNewValue )
|
|
raises( com::sun::star::lang::IllegalArgumentException,
|
|
com::sun::star::lang::ArrayIndexOutOfBoundsException );
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
/*=============================================================================
|
|
|
|
=============================================================================*/
|
|
#endif
|