summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/PropertyAttribute.idl
blob: 5ce79087bf652d2b51c17f9a4d72ec4f57e3e746 (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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: PropertyAttribute.idl,v $
 * $Revision: 1.18 $
 *
 * 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_beans_PropertyAttribute_idl__
#define __com_sun_star_beans_PropertyAttribute_idl__

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

 module com {  module sun {  module star {  module beans {

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

/** These values are used to specify the behavior of a <type>Property</type>.
 */
published constants PropertyAttribute
{
    //-------------------------------------------------------------------------

    /** indicates that a property value can be void.

        <p>It does not mean that the type of the property is void!
     */
    const short MAYBEVOID = 1;

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

    /** indicates that a <type>PropertyChangeEvent</type> will be fired
        to all registered <type>XPropertyChangeListener</type>s whenever the
        value of this property changes.
     */
    const short BOUND = 2;

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

    /** indicates that a <type>PropertyChangeEvent</type> will be fired
        to all registered <type>XVetoableChangeListener</type>s whenever the
        value of this property changes.

            <p>This always implies that the property is <em>bound</em>, too. </p>
     */
    const short CONSTRAINED = 4;

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

    /** indicates that the value of the property is not persistent.
     */
    const short TRANSIENT = 8;

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

    /** indicates that the value of the property is read-only.
     */
    const short READONLY = 16;

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

    /** indicates that the value of the property can be ambiguous.
     */
    const short MAYBEAMBIGUOUS = 32;

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

    /** indicates that the property can be set to default.
     */
    const short MAYBEDEFAULT = 64;

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

    /** indicates that the property can be removed
        (i.e., by calling <member>XPropertyContainer::removeProperty</member>).
     */
    const short REMOVEABLE = 128;

    //-------------------------------------------------------------------------
    /** @deprecated
        same as <const>PropertyAttribute::REMOVEABLE</const>.
     */
    const short REMOVABLE = 128;

    //-------------------------------------------------------------------------
    /** indicates that a property is optional.

        <p>This attribute is not of interest for concrete property
        implementations. It's needed for property specifications inside
        service specifications in UNOIDL.

        @see com::sun::star::reflection::XPropertyTypeDescription
        @see com::sun::star::reflection::XServiceTypeDescription
    @since OOo 1.1.2
     */
    const short OPTIONAL = 256;
};

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

}; }; }; };

#endif