xref: /aoo41x/main/udkapi/com/sun/star/container/XIndexContainer.idl (revision 408a4873)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_container_XIndexContainer_idl__
#define __com_sun_star_container_XIndexContainer_idl__

#ifndef __com_sun_star_container_XIndexReplace_idl__
#include <com/sun/star/container/XIndexReplace.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module container {

//=============================================================================

/** This is the generic interface for supporting the insertion and removal of
	indexed elements.@see XContainer
 */
published interface XIndexContainer: com::sun::star::container::XIndexReplace
{
	//-------------------------------------------------------------------------

	/** inserts the given element at the specified index.

		<p>To append an element, use the index "last index +1".  </p>
	 */
	void insertByIndex( [in] long Index,
			 [in] any Element )
			raises( com::sun::star::lang::IllegalArgumentException,
					com::sun::star::lang::IndexOutOfBoundsException,
					com::sun::star::lang::WrappedTargetException );

	//-------------------------------------------------------------------------

	/** removes the element at the specified index.
	 */
	void removeByIndex( [in] long Index )
			raises( com::sun::star::lang::IndexOutOfBoundsException,
					com::sun::star::lang::WrappedTargetException );

};

//=============================================================================

}; }; }; };

#endif