/*************************************************************************
 *
 *  $RCSfile: XLayerManager.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/02 15:12:32 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_XLayerManager_idl__ 
#define __com_sun_star_drawing_XLayerManager_idl__ 
 
#ifndef __com_sun_star_container_XIndexAccess_idl__ 
#include <com/sun/star/container/XIndexAccess.idl> 
#endif 
 
#ifndef __com_sun_star_drawing_XLayer_idl__ 
#include <com/sun/star/drawing/XLayer.idl> 
#endif 
 
#ifndef __com_sun_star_container_NoSuchElementException_idl__ 
#include <com/sun/star/container/NoSuchElementException.idl> 
#endif 
 
#ifndef __com_sun_star_drawing_XShape_idl__ 
#include <com/sun/star/drawing/XShape.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module drawing {  
 
//============================================================================= 
 
/** This interface makes it possible to access and manage the
	<type>Layer</type>s	of a document.

	@see LayerManager
 */
interface XLayerManager: com::sun::star::container::XIndexAccess
{ 
	//------------------------------------------------------------------------- 
	 
	/** creates a new <type>Layer</type>

		@param nIndex
			the index at which the new layer is inserted

		@returns
			the new created <type>Layer</type>
	 */
	com::sun::star::drawing::XLayer insertNewByIndex( [in] long nIndex ); 
 
	//------------------------------------------------------------------------- 
	 
	/** removes a <type>Layer</type> and all <type>Shape</type>s on
		this <type>Layer</type>.

		@param xLayer
			this <type>Layer</type> will be removed and disposed
	 */
	void remove( [in] com::sun::star::drawing::XLayer xLayer ) 
			raises( com::sun::star::container::NoSuchElementException ); 
 
	//------------------------------------------------------------------------- 
	 
	/** attaches a <type>Shape</type> to the given <type>Layer</type>.

		@param xShape
			this is the <type>Shape</type> that will be attached to a <type>Layer</type>

		@param xLayer
			this is the <type>Layer</type> that will be attached to a <type>Shape</type>
	 */
	void attachShapeToLayer( [in] com::sun::star::drawing::XShape xShape, 
			 [in] com::sun::star::drawing::XLayer xLayer ); 
 
	//------------------------------------------------------------------------- 
	 
	/** queries the <type>Layer</type> that a <type>Shape</type> is attached to

		@param xShape 
			specifies the <type>Shape</type> for which the layer is requested.

		@returns 
			the <type>Layer</type> to which the <type>Shape</type> is 
			attached. 
				 
	 */
	com::sun::star::drawing::XLayer getLayerForShape( [in] com::sun::star::drawing::XShape xShape ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif 

