summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/XMultiPropertySet.idl
blob: b0902242379be5deb65df92cdee672bbcc53e346 (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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/*************************************************************************
 *
 *  $RCSfile: XMultiPropertySet.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:32 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_beans_XMultiPropertySet_idl__ 
#define __com_sun_star_beans_XMultiPropertySet_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XPropertySetInfo_idl__ 
#include <com/sun/star/beans/XPropertySetInfo.idl> 
#endif 
 
#ifndef __com_sun_star_beans_PropertyVetoException_idl__ 
#include <com/sun/star/beans/PropertyVetoException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 
#include <com/sun/star/lang/WrappedTargetException.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XPropertiesChangeListener_idl__ 
#include <com/sun/star/beans/XPropertiesChangeListener.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module beans {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::beans::XMultiPropertySet
/** provides access to multiple properties with a single call.
 */
interface XMultiPropertySet: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::beans::XMultiPropertySet::getPropertySetInfo
    /** @returns 
            the <type>XPropertySetInfo</type> interface, which describes  
            all properties of the object to which this interface belongs.  
            <const>NULL</const> is returned if the object cannot or will 
            not provide information	about the properties. 
                 
        @see XPropertySet::getPropertySetInfo
     */
    com::sun::star::beans::XPropertySetInfo getPropertySetInfo(); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::setPropertyValues
    /** sets the values to the properties with the specified names.
        
        <p>The values of the properties must change before the bound 
        events are fired. The values of the constrained properties 
        should change after the vetoable events are fired and after if no 
        exception occur Unknown properties are ignored.  </p>

        @param aPropertyNames
            specifies the names of the properties. All names must be unique.
            This sequence must be alphabetically sorted.

        @param aValues
            contains the new values of the properties. The order is the same
            as in <var>aPropertyNames</var>.

        @throws IllegalArgumentException
            if one of th enew values cannot be converted to the type
            of the unterlying property by an identity or widening conversion.

        @throws com::sun::star::lang:WrappedTargetException
            if the implementation has an internal reason for the exception.
            In this case the original exception is wrapped.
     */
    void setPropertyValues( [in] sequence<string> aPropertyNames, 
             [in] sequence<any> aValues ) 
            raises( com::sun::star::beans::PropertyVetoException, 
                    com::sun::star::lang::IllegalArgumentException, 
                    com::sun::star::lang::WrappedTargetException ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::beans::XMultiPropertySet::getPropertyValues
    /** @returns 
            a sequence of all values of the properties which are specified by their names. 
         
        <p>The order of the values in the returned sequence will be the same  
        as the order of the names in the argument. </p>

        @param aPropertyNames
            specifies the names of the properties. 
            This sequence must be alphabetically sorted.
     */
    sequence<any> getPropertyValues( [in] sequence<string> aPropertyNames ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::addPropertiesChangeListener
    /** adds an <type>XPropertiesChangeListener</type> to the 
        specified property with the specified names.
        
        <p>The implementation can ignore the names of the properties
        and fire the event on all properties. </p>

        @param aPropertyNames
            specifies the names of the properties.

        @param xListener
            contains the listener for the property change events.

        @see removePropertiesChangeListener 
     */
    [oneway] void addPropertiesChangeListener( [in] sequence<string> aPropertyNames, 
             [in] com::sun::star::beans::XPropertiesChangeListener xListener ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::removePropertiesChangeListener
    /** removes an <type>XPropertiesChangeListener</type> from the listener list.
        
        <p>It is a "noop" if the listener is not registered.  </p>

        @param
            contains th elistener to be removed.

        @see addPropertiesChangeListener
     */
    [oneway] void removePropertiesChangeListener( [in] com::sun::star::beans::XPropertiesChangeListener xListener ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::firePropertiesChangeEvent
    /** fires a sequence of <type>PropertyChangeEvent</type>s to the specified 
        listener.

        @param aPropertynames
            specifies the sorted names of the properties.

        @param xListener
            contains the listener for the property change events.
     */
    [oneway] void firePropertiesChangeEvent( [in] sequence<string> aPropertyNames, 
             [in] com::sun::star::beans::XPropertiesChangeListener xListener ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.7  2000/12/19 16:15:24  mi
    documentation syntax fixed
    
    Revision 1.6  2000/12/15 16:22:48  mi
    lost documentation from src536 inserted
    
    Revision 1.5  2000/12/11 16:09:35  mi
    documentation syntax fixed and some minor semantic documentation fixes
    
    Revision 1.4  2000/11/08 12:28:20  mi
    moved from api
    
    Revision 1.1.1.1  2000/09/18 23:34:56  hjs
    initial import
    
    Revision 1.6  2000/09/11 11:52:11  mi
    documentation merged from XML
     
    Revision 1.4  2000/02/23 12:43:24  mi 
    missing documentations 
     
    Revision 1.3  2000/02/17 09:30:05  mi 
    proofreading in layouted version 
     
    Revision 1.2  2000/02/07 11:24:18  mi 
    zu #70728# missing documentation marked 
     
    Revision 1.1.1.1  1999/11/11 09:48:40  jsc 
    new 
     
 
=============================================================================*/ 
#endif