1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XIndexAccess_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_container_XIndexAccess_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XElementAccess_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XElementAccess.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module container { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski/** provides access to the elements of a collection through an 46*b1cdbd2cSJim Jagielski index. 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski <p>This interface should only be used if the data structure, itself, 49*b1cdbd2cSJim Jagielski is indexed.</p> 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielskipublished interface XIndexAccess: com::sun::star::container::XElementAccess 52*b1cdbd2cSJim Jagielski{ 53*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski /** @returns 56*b1cdbd2cSJim Jagielski the number of elements in this container. 57*b1cdbd2cSJim Jagielski */ 58*b1cdbd2cSJim Jagielski long getCount(); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski // DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex 63*b1cdbd2cSJim Jagielski /** @returns 64*b1cdbd2cSJim Jagielski the element at the specified index. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @param Index 67*b1cdbd2cSJim Jagielski specifies the position in the array. The first index is 0. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::IndexOutOfBoundException 70*b1cdbd2cSJim Jagielski if the index is not valid. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 73*b1cdbd2cSJim Jagielski If the implementation has internal reasons for exceptions, 74*b1cdbd2cSJim Jagielski then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type> 75*b1cdbd2cSJim Jagielski exception. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski any getByIndex( [in] long Index ) 78*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IndexOutOfBoundsException, 79*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski}; 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski//============================================================================= 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski}; }; }; }; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski#endif 88