udkapi/com/sun/star/container/XIndexContainer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XIndexContainer.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_container_XIndexContainer_idl__
  31 #define __com_sun_star_container_XIndexContainer_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexReplace_idl__
  34 #include <com/sun/star/container/XIndexReplace.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  42 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  46 #include <com/sun/star/lang/WrappedTargetException.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com {  module sun {  module star {  module container {
  52
  53 //=============================================================================
  54
  55 /** This is the generic interface for supporting the insertion and removal of
  56     indexed elements.@see XContainer
  57  */
  58 published interface XIndexContainer: com::sun::star::container::XIndexReplace
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     /** inserts the given element at the specified index.
  63
  64         <p>To append an element, use the index "last index +1".  </p>
  65      */
  66     void insertByIndex( [in] long Index,
  67              [in] any Element )
  68             raises( com::sun::star::lang::IllegalArgumentException,
  69                     com::sun::star::lang::IndexOutOfBoundsException,
  70                     com::sun::star::lang::WrappedTargetException );
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** removes the element at the specified index.
  75      */
  76     void removeByIndex( [in] long Index )
  77             raises( com::sun::star::lang::IndexOutOfBoundsException,
  78                     com::sun::star::lang::WrappedTargetException );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif