summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/Layer.idl
blob: a8a4476966eb97fa1c093527920cfadb3cd8026c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_Layer_idl__
#define __com_sun_star_drawing_Layer_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module drawing {

//=============================================================================

// DocMerge from xml: service com::sun::star::drawing::Layer
/** A layer is an entity inside a document which contains shapes.


    <p>There could be zero or more <type>Shape</type>s attached to
    such a layer.

    </p>
    <p>The properties of a <type>Layer</type> instance affect all <type>Shape</type>s
    attached to the Layer.

    </p>

    @see    DrawingDocument
    @see LayerManager
 */
published service Layer
{


    // DocMerge from xml: service com::sun::star::drawing::Layer: interface com::sun::star::beans::XPropertySet
    /** The properties in this set affect all <type>Shape</type>s attached to
                this Layer.
     */
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::drawing::Layer::Name
    /** The name of a <type>Layer</type> is used to identify the
        <type>Layer</type> in the user interface.
     */
    [property] string Name;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::drawing::Layer::IsVisible
    /** If a <type>Layer</type> is not visible, the objects in this
        <type>Layer</type> are not shown in the user interface.
     */
    [property] boolean IsVisible;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::drawing::Layer::IsPrintable
    /** If a <type>Layer</type> is not printable, the objects in
        this <type>Layer</type> are not printed.
     */
    [property] boolean IsPrintable;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::drawing::Layer::IsLocked
    /** If a <type>Layer</type> is locked, the objects in this
        <type>Layer</type> cannot be edited in the user interface.
     */
    [property] boolean IsLocked;

};

//=============================================================================

}; }; }; };

#endif