xref: /trunk/main/udkapi/com/sun/star/beans/Property.idl (revision 66b843ff8f1eedd2e69941f1ea52fa080f01ec28)
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_Property_idl__
24#define __com_sun_star_beans_Property_idl__
25
26#ifndef __com_sun_star_reflection_XIdlClass_idl__
27#include <com/sun/star/reflection/XIdlClass.idl>
28#endif
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module beans {
34
35//=============================================================================
36
37/** This structure describes a property.
38
39    <dl>There are three types of properties:
40        <dt>- bound properties</dt>
41        <dt>- constrained properties</dt>
42        <dt>- free properties</dt>
43    </dl>
44 */
45published struct Property
46{
47    //-------------------------------------------------------------------------
48
49    /** specifies the name of the property.
50
51        <p> The name is unique within an <type>XPropertySet</type>.
52            Upper and lower case are distinguished.</p>
53     */
54    string Name;
55
56    //-------------------------------------------------------------------------
57
58    /** contains an implementation-specific handle for the property.
59
60        <p> It may be -1 if the implementation has no handle. You can use
61            this handle to get values from the <type>XFastPropertySet</type>.</p>
62     */
63    long Handle;
64
65    //-------------------------------------------------------------------------
66
67    /** contains an object that identifies the declared type for the property.
68
69        <p> If the property has multiple types or the type is not
70            known, <strong>but not an <atom>any</atom></strong>, then
71            <const>void</const> must be returned.</p>
72     */
73    type Type;
74
75    //-------------------------------------------------------------------------
76
77    /** This field may contain zero or more constants of the
78        <type>PropertyAttribute</type> constants group.
79     */
80    short Attributes;
81
82    //-------------------------------------------------------------------------
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91