1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_container_XIndexAccess_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_container_XElementAccess_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/container/XElementAccess.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//============================================================================= 44*cdf0e10cSrcweir 45*cdf0e10cSrcweirmodule com { module sun { module star { module container { 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir//============================================================================= 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir/** provides access to the elements of a collection through an 50*cdf0e10cSrcweir index. 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir <p>This interface should only be used if the data structure, itself, 53*cdf0e10cSrcweir is indexed.</p> 54*cdf0e10cSrcweir */ 55*cdf0e10cSrcweirpublished interface XIndexAccess: com::sun::star::container::XElementAccess 56*cdf0e10cSrcweir{ 57*cdf0e10cSrcweir //------------------------------------------------------------------------- 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir /** @returns 60*cdf0e10cSrcweir the number of elements in this container. 61*cdf0e10cSrcweir */ 62*cdf0e10cSrcweir long getCount(); 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir //------------------------------------------------------------------------- 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir // DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex 67*cdf0e10cSrcweir /** @returns 68*cdf0e10cSrcweir the element at the specified index. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @param Index 71*cdf0e10cSrcweir specifies the position in the array. The first index is 0. 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir @throws com::sun::star::lang::IndexOutOfBoundException 74*cdf0e10cSrcweir if the index is not valid. 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 77*cdf0e10cSrcweir If the implementation has internal reasons for exceptions, 78*cdf0e10cSrcweir then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type> 79*cdf0e10cSrcweir exception. 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir any getByIndex( [in] long Index ) 82*cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException, 83*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir}; 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir//============================================================================= 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir}; }; }; }; 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir#endif 92