xref: /AOO41X/main/udkapi/com/sun/star/beans/PropertyValue.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
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_PropertyValue_idl__
24#define __com_sun_star_beans_PropertyValue_idl__
25
26#ifndef __com_sun_star_beans_Property_idl__
27#include <com/sun/star/beans/Property.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyState_idl__
31#include <com/sun/star/beans/PropertyState.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module beans {
38
39//=============================================================================
40
41/** specifies a property value.
42 */
43published struct PropertyValue
44{
45    /** specifies the name of the property.
46
47        <p>The name is unique within a sequence of <type>PropertyValue</type>s.
48        Upper and lower case are distinguished.</p>
49     */
50    string Name;
51
52    //-------------------------------------------------------------------------
53
54    /** contains an implementation-specific handle for the property.
55
56        <p>It may be -1 if the implementation has no handle. If available
57        it can be used for fast lookups.</p>
58     */
59    long Handle;
60
61    //-------------------------------------------------------------------------
62
63    /** contains the value of the property or <void/>,
64        if no value is available.
65     */
66    any Value;
67
68    //-------------------------------------------------------------------------
69
70    /** determines if the value comes from the object itself or from
71        a default and if the value cannot be determined exactly.
72     */
73    com::sun::star::beans::PropertyState State;
74
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82