xref: /aoo42x/main/offapi/com/sun/star/drawing/Layer.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_drawing_Layer_idl__
24#define __com_sun_star_drawing_Layer_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module drawing {
34
35//=============================================================================
36
37// DocMerge from xml: service com::sun::star::drawing::Layer
38/** A layer is an entity inside a document which contains shapes.
39
40
41	<p>There could be zero or more <type>Shape</type>s attached to
42	such a layer.
43
44	</p>
45	<p>The properties of a <type>Layer</type> instance affect all <type>Shape</type>s
46	attached to the Layer.
47
48	</p>
49
50	@see	DrawingDocument
51	@see LayerManager
52 */
53published service Layer
54{
55
56
57	// DocMerge from xml: service com::sun::star::drawing::Layer: interface com::sun::star::beans::XPropertySet
58	/** The properties in this set affect all <type>Shape</type>s attached to
59				this Layer.
60	 */
61	interface com::sun::star::beans::XPropertySet;
62
63	//-------------------------------------------------------------------------
64
65	// DocMerge from xml: property com::sun::star::drawing::Layer::Name
66	/** The name of a <type>Layer</type> is used to identify the
67		<type>Layer</type> in the user interface.
68	 */
69	[property] string Name;
70
71	//-------------------------------------------------------------------------
72
73	// DocMerge from xml: property com::sun::star::drawing::Layer::IsVisible
74	/** If a <type>Layer</type> is not visible, the objects in this
75		<type>Layer</type> are not shown in the user interface.
76	 */
77	[property] boolean IsVisible;
78
79	//-------------------------------------------------------------------------
80
81	// DocMerge from xml: property com::sun::star::drawing::Layer::IsPrintable
82	/** If a <type>Layer</type> is not printable, the objects in
83		this <type>Layer</type> are not printed.
84	 */
85	[property] boolean IsPrintable;
86
87	//-------------------------------------------------------------------------
88
89	// DocMerge from xml: property com::sun::star::drawing::Layer::IsLocked
90	/** If a <type>Layer</type> is locked, the objects in this
91		<type>Layer</type> cannot be edited in the user interface.
92	 */
93	[property] boolean IsLocked;
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102
103