summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/beans/XPropertySet.idl
blob: bcf97fa6edd995aac370c9fdc800ad7dab8e1dc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_beans_XPropertySet_idl__
#define __com_sun_star_beans_XPropertySet_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/beans/XPropertySetInfo.idl>

#include <com/sun/star/beans/UnknownPropertyException.idl>

#include <com/sun/star/beans/PropertyVetoException.idl>

#include <com/sun/star/lang/IllegalArgumentException.idl>

#include <com/sun/star/lang/WrappedTargetException.idl>

#include <com/sun/star/beans/XPropertyChangeListener.idl>

#include <com/sun/star/beans/XVetoableChangeListener.idl>



module com {  module sun {  module star {  module beans {


/** provides information about and access to the
    properties from an implementation.

    <p>There are three types of properties: </p>

    <ul>
        <li>bound properties </li>
        <li>constrained properties </li>
        <li>free properties </li>
    </ul>

    <p>You can listen to changes of bound properties with the
    XPropertyChangeListener and you can veto changes
    of constrained properties with the XVetoableChangeListener.  </p>

    <p>To implement inaccurate name access, you must support the
    interface XExactName. </p>

    @see com::sun::star::beans::XExactName
 */
published interface XPropertySet: com::sun::star::uno::XInterface
{

    /** @returns
            the XPropertySetInfo interface, which
            describes all properties of the object which supplies this
            interface.

        @returns
            NULL if the implementation cannot or will
            not provide information about the properties; otherwise the
            interface XPropertySetInfo is returned.
     */
    com::sun::star::beans::XPropertySetInfo getPropertySetInfo();


    /** sets the value of the property with the specified name.

        <p>If it is a bound property the value will be changed before
        the change event is fired.  If it is a constrained property
        a vetoable event is fired before the property value can be
        changed.  </p>

        @throws com::sun::star::beans::PropertyVetoException
            if the property is read-only or vetoable
            and one of the listeners throws this exception
            because of an unaccepted new value.
     */
    void setPropertyValue( [in] string aPropertyName,
             [in] any aValue )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::beans::PropertyVetoException,
                    com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::lang::WrappedTargetException );


    /** @returns
            the value of the property with the specified name.

        @param PropertyName
            This parameter specifies the name of the property.

        @throws UnknownPropertyException
            if the property does not exist.

        @throws com::sun::star::lang::WrappedTargetException
            if the implementation has an internal reason for the exception.
            In this case the original exception is wrapped into that
            com::sun::star::lang::WrappedTargetException.
     */
    any getPropertyValue( [in] string PropertyName )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** adds an XPropertyChangeListener to the specified property.

        <p>An empty name ("") registers the listener to all bound
        properties. If the property is not bound, the behavior is
        not specified.  </p>

        <p>It is suggested to allow multiple registration of the same listener,
        thus for each time a listener is added, it has to be removed.

        @see removePropertyChangeListener
     */
    void addPropertyChangeListener( [in] string aPropertyName,
             [in] com::sun::star::beans::XPropertyChangeListener xListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** removes an XPropertyChangeListener from
        the listener list.

        <p>It is a "noop" if the listener is not registered.  </p>

        <p>It is suggested to allow multiple registration of the same listener,
        thus for each time a listener is added, it has to be removed.

        @see addPropertyChangeListener
     */
    void removePropertyChangeListener( [in] string aPropertyName,
             [in] com::sun::star::beans::XPropertyChangeListener aListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** adds an XVetoableChangeListener to the specified
        property with the name PropertyName.

        <p>An empty name ("") registers the listener to all
        constrained properties. If the property is not constrained,
        the behavior is not specified.  </p>

        @see removeVetoableChangeListener
     */
    void addVetoableChangeListener( [in] string PropertyName,
             [in] com::sun::star::beans::XVetoableChangeListener aListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );


    /** removes an XVetoableChangeListener from the
        listener list.

        <p>It is a "noop" if the listener is not registered.  </p>

        @see addVetoableChangeListener
     */
    void removeVetoableChangeListener( [in] string PropertyName,
             [in] com::sun::star::beans::XVetoableChangeListener aListener )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::WrappedTargetException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */