offapi/com/sun/star/drawing/Layer.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: Layer.idl,v $
  10  * $Revision: 1.9 $
  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_Layer_idl__
  31 #define __com_sun_star_drawing_Layer_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module drawing {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: service com::sun::star::drawing::Layer
  45 /** A layer is an entity inside a document which contains shapes.
  46
  47
  48     <p>There could be zero or more <type>Shape</type>s attached to
  49     such a layer.
  50
  51     </p>
  52     <p>The properties of a <type>Layer</type> instance affect all <type>Shape</type>s
  53     attached to the Layer.
  54
  55     </p>
  56
  57     @see        DrawingDocument
  58     @see LayerManager
  59  */
  60 published service Layer
  61 {
  62
  63
  64     // DocMerge from xml: service com::sun::star::drawing::Layer: interface com::sun::star::beans::XPropertySet
  65     /** The properties in this set affect all <type>Shape</type>s attached to
  66                 this Layer.
  67      */
  68     interface com::sun::star::beans::XPropertySet;
  69
  70     //-------------------------------------------------------------------------
  71
  72     // DocMerge from xml: property com::sun::star::drawing::Layer::Name
  73     /** The name of a <type>Layer</type> is used to identify the
  74         <type>Layer</type> in the user interface.
  75      */
  76     [property] string Name;
  77
  78     //-------------------------------------------------------------------------
  79
  80     // DocMerge from xml: property com::sun::star::drawing::Layer::IsVisible
  81     /** If a <type>Layer</type> is not visible, the objects in this
  82         <type>Layer</type> are not shown in the user interface.
  83      */
  84     [property] boolean IsVisible;
  85
  86     //-------------------------------------------------------------------------
  87
  88     // DocMerge from xml: property com::sun::star::drawing::Layer::IsPrintable
  89     /** If a <type>Layer</type> is not printable, the objects in
  90         this <type>Layer</type> are not printed.
  91      */
  92     [property] boolean IsPrintable;
  93
  94     //-------------------------------------------------------------------------
  95
  96     // DocMerge from xml: property com::sun::star::drawing::Layer::IsLocked
  97     /** If a <type>Layer</type> is locked, the objects in this
  98         <type>Layer</type> cannot be edited in the user interface.
  99      */
 100     [property] boolean IsLocked;
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif
 109