xref: /aoo41x/main/udkapi/com/sun/star/beans/Property.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_beans_Property_idl__
28#define __com_sun_star_beans_Property_idl__
29
30#ifndef __com_sun_star_reflection_XIdlClass_idl__
31#include <com/sun/star/reflection/XIdlClass.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module beans {
38
39//=============================================================================
40
41/** This structure describes a property.
42
43
44	<dl>There are three types of properties:
45		<dt>- bound properties</dt>
46		<dt>- constrained properties</dt>
47		<dt>- free properties</dt>
48	</dl>
49 */
50published struct Property
51{
52	/** specifies the name of the property.
53
54		<p>The name is unique within an <type>XPropertySet</type>.
55		Upper and lower case are distinguished.</p>
56	 */
57	string Name;
58
59	//-------------------------------------------------------------------------
60
61	/** contains an implementation-specific handle for the property.
62
63		<p>It may be -1 if the implementation has no handle. You can use
64		this handle to get values from the <type>XFastPropertySet</type>.</p>
65	 */
66	long Handle;
67
68	//-------------------------------------------------------------------------
69
70	/** contains an object that identifies the declared type for
71		the property.
72
73		<p>If the property has multiple types or the type is not
74		known, <strong>but not an <atom>any</atom></strong>, then
75		<const>void</const> must be returned.</p>
76	 */
77	type Type;
78
79	//-------------------------------------------------------------------------
80
81	/** This field may contain zero or more constants of the
82		<type>PropertyAttribute</type> constants group.
83	 */
84	short Attributes;
85
86};
87
88//=============================================================================
89
90}; }; }; };
91
92#endif
93