xref: /aoo41x/main/offapi/com/sun/star/drawing/Layer.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_drawing_Layer_idl__
28#define __com_sun_star_drawing_Layer_idl__
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module drawing {
38
39//=============================================================================
40
41// DocMerge from xml: service com::sun::star::drawing::Layer
42/** A layer is an entity inside a document which contains shapes.
43
44
45	<p>There could be zero or more <type>Shape</type>s attached to
46	such a layer.
47
48	</p>
49	<p>The properties of a <type>Layer</type> instance affect all <type>Shape</type>s
50	attached to the Layer.
51
52	</p>
53
54	@see	DrawingDocument
55	@see LayerManager
56 */
57published service Layer
58{
59
60
61	// DocMerge from xml: service com::sun::star::drawing::Layer: interface com::sun::star::beans::XPropertySet
62	/** The properties in this set affect all <type>Shape</type>s attached to
63				this Layer.
64	 */
65	interface com::sun::star::beans::XPropertySet;
66
67	//-------------------------------------------------------------------------
68
69	// DocMerge from xml: property com::sun::star::drawing::Layer::Name
70	/** The name of a <type>Layer</type> is used to identify the
71		<type>Layer</type> in the user interface.
72	 */
73	[property] string Name;
74
75	//-------------------------------------------------------------------------
76
77	// DocMerge from xml: property com::sun::star::drawing::Layer::IsVisible
78	/** If a <type>Layer</type> is not visible, the objects in this
79		<type>Layer</type> are not shown in the user interface.
80	 */
81	[property] boolean IsVisible;
82
83	//-------------------------------------------------------------------------
84
85	// DocMerge from xml: property com::sun::star::drawing::Layer::IsPrintable
86	/** If a <type>Layer</type> is not printable, the objects in
87		this <type>Layer</type> are not printed.
88	 */
89	[property] boolean IsPrintable;
90
91	//-------------------------------------------------------------------------
92
93	// DocMerge from xml: property com::sun::star::drawing::Layer::IsLocked
94	/** If a <type>Layer</type> is locked, the objects in this
95		<type>Layer</type> cannot be edited in the user interface.
96	 */
97	[property] boolean IsLocked;
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106
107