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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XIndexContainer_idl__
  20 #define __com_sun_star_container_XIndexContainer_idl__
  21
  22 #include <com/sun/star/container/XIndexReplace.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  27
  28 #include <com/sun/star/lang/WrappedTargetException.idl>
  29
  30
  31 module com {  module sun {  module star {  module container {
  32
  33
  34 /** This is the generic interface for supporting the insertion and removal of
  35     indexed elements.@see XContainer
  36  */
  37 published interface XIndexContainer: com::sun::star::container::XIndexReplace
  38 {
  39
  40     /** inserts the given element at the specified index.
  41
  42         <p>To append an element, use the index "last index +1".  </p>
  43      */
  44     void insertByIndex( [in] long Index,
  45              [in] any Element )
  46             raises( com::sun::star::lang::IllegalArgumentException,
  47                     com::sun::star::lang::IndexOutOfBoundsException,
  48                     com::sun::star::lang::WrappedTargetException );
  49
  50
  51     /** removes the element at the specified index.
  52      */
  53     void removeByIndex( [in] long Index )
  54             raises( com::sun::star::lang::IndexOutOfBoundsException,
  55                     com::sun::star::lang::WrappedTargetException );
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */