xref: /AOO41X/main/udkapi/com/sun/star/beans/PropertyAttribute.idl (revision 95a17a3241948ee8325fc93f67c7134331266fe4)
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_beans_PropertyAttribute_idl__
24#define __com_sun_star_beans_PropertyAttribute_idl__
25
26//=============================================================================
27
28 module com {  module sun {  module star {  module beans {
29
30//=============================================================================
31
32/** These values are used to specify the behavior of a <type>Property</type>.
33 */
34published constants PropertyAttribute
35{
36    //-------------------------------------------------------------------------
37
38    /** indicates that a property value can be void.
39
40        <p>It does not mean that the type of the property is void!
41     */
42    const short MAYBEVOID = 1;
43
44    //-------------------------------------------------------------------------
45
46    /** indicates that a <type>PropertyChangeEvent</type> will be fired
47        to all registered <type>XPropertyChangeListener</type>s whenever the
48        value of this property changes.
49     */
50    const short BOUND = 2;
51
52    //-------------------------------------------------------------------------
53
54    /** indicates that a <type>PropertyChangeEvent</type> will be fired
55        to all registered <type>XVetoableChangeListener</type>s whenever the
56        value of this property changes.
57
58            <p>This always implies that the property is <em>bound</em>, too. </p>
59     */
60    const short CONSTRAINED = 4;
61
62    //-------------------------------------------------------------------------
63
64    /** indicates that the value of the property is not persistent.
65     */
66    const short TRANSIENT = 8;
67
68    //-------------------------------------------------------------------------
69
70    /** indicates that the value of the property is read-only.
71     */
72    const short READONLY = 16;
73
74    //-------------------------------------------------------------------------
75
76    /** indicates that the value of the property can be ambiguous.
77     */
78    const short MAYBEAMBIGUOUS = 32;
79
80    //-------------------------------------------------------------------------
81
82    /** indicates that the property can be set to default.
83     */
84    const short MAYBEDEFAULT = 64;
85
86    //-------------------------------------------------------------------------
87
88    /** indicates that the property can be removed
89        (i.e., by calling <member>XPropertyContainer::removeProperty</member>).
90     */
91    const short REMOVEABLE = 128;
92
93    //-------------------------------------------------------------------------
94    /** @deprecated
95        same as <const>PropertyAttribute::REMOVEABLE</const>.
96     */
97    const short REMOVABLE = 128;
98
99    //-------------------------------------------------------------------------
100    /** indicates that a property is optional.
101
102        <p>This attribute is not of interest for concrete property
103        implementations. It's needed for property specifications inside
104        service specifications in UNOIDL.
105
106        @see com::sun::star::reflection::XPropertyTypeDescription
107        @see com::sun::star::reflection::XServiceTypeDescription
108    @since OpenOffice 1.1.2
109     */
110    const short OPTIONAL = 256;
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118