xref: /AOO42X/main/udkapi/com/sun/star/beans/XPropertySetInfo.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_XPropertySetInfo_idl__
28#define __com_sun_star_beans_XPropertySetInfo_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_beans_Property_idl__
35#include <com/sun/star/beans/Property.idl>
36#endif
37
38#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
39#include <com/sun/star/beans/UnknownPropertyException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module beans {
46
47//=============================================================================
48
49/** specifies a set of properties.
50
51    <p>There are three kinds of properties:
52    <ul>
53        <li>bound properties</li>
54        <li>constrained properties</li>
55        <li>free properties</li>
56    </ul>
57
58    <p>The specification only describes the properties, it does not contain
59    any values.</p>
60 */
61published interface XPropertySetInfo: com::sun::star::uno::XInterface
62{
63    //-------------------------------------------------------------------------
64
65    /** @returns
66            a sequence with all property descriptors which are specified
67            within this <type>XPropertySetInfo</type>.
68     */
69    sequence<com::sun::star::beans::Property> getProperties();
70
71    //-------------------------------------------------------------------------
72
73    /** @returns
74            the property with the specified name from the object.
75
76        @param aName
77            specifies the name of the property.
78
79        @throws UnknownPropertyException
80            if the property does not exist.
81     */
82    com::sun::star::beans::Property getPropertyByName( [in] string aName )
83            raises( com::sun::star::beans::UnknownPropertyException );
84
85    //-------------------------------------------------------------------------
86
87    /** @returns
88            <TRUE/> if a property with the specified name exist;
89            otherwise <FALSE/> is returned.
90
91        @param aName
92            specifies the name of the property.
93     */
94    boolean hasPropertyByName( [in] string Name );
95
96};
97
98//=============================================================================
99
100}; }; }; };
101
102#endif
103