offapi/com/sun/star/drawing/XLayerManager.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: XLayerManager.idl,v $
  10  * $Revision: 1.8 $
  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_drawing_XLayerManager_idl__
  31 #define __com_sun_star_drawing_XLayerManager_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexAccess_idl__
  34 #include <com/sun/star/container/XIndexAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XLayer_idl__
  38 #include <com/sun/star/drawing/XLayer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  42 #include <com/sun/star/container/NoSuchElementException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_XShape_idl__
  46 #include <com/sun/star/drawing/XShape.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module drawing {
  53
  54 //=============================================================================
  55
  56 /** This interface makes it possible to access and manage the
  57     <type>Layer</type>s of a document.
  58
  59     @see LayerManager
  60  */
  61 published interface XLayerManager: com::sun::star::container::XIndexAccess
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** creates a new <type>Layer</type>
  66
  67         @param nIndex
  68             the index at which the new layer is inserted
  69
  70         @returns
  71             the new created <type>Layer</type>
  72      */
  73     com::sun::star::drawing::XLayer insertNewByIndex( [in] long nIndex );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** removes a <type>Layer</type> and all <type>Shape</type>s on
  78         this <type>Layer</type>.
  79
  80         @param xLayer
  81             this <type>Layer</type> will be removed and disposed
  82      */
  83     void remove( [in] com::sun::star::drawing::XLayer xLayer )
  84             raises( com::sun::star::container::NoSuchElementException );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** attaches a <type>Shape</type> to the given <type>Layer</type>.
  89
  90         @param xShape
  91             this is the <type>Shape</type> that will be attached to a <type>Layer</type>
  92
  93         @param xLayer
  94             this is the <type>Layer</type> that will be attached to a <type>Shape</type>
  95      */
  96     void attachShapeToLayer( [in] com::sun::star::drawing::XShape xShape,
  97              [in] com::sun::star::drawing::XLayer xLayer );
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** queries the <type>Layer</type> that a <type>Shape</type> is attached to
 102
 103         @param xShape
 104             specifies the <type>Shape</type> for which the layer is requested.
 105
 106         @returns
 107             the <type>Layer</type> to which the <type>Shape</type> is
 108             attached.
 109
 110      */
 111     com::sun::star::drawing::XLayer getLayerForShape( [in] com::sun::star::drawing::XShape xShape );
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif
 120