1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XMultiPropertySet_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_beans_XMultiPropertySet_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertySetInfo_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertySetInfo.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_PropertyVetoException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/PropertyVetoException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertiesChangeListener_idl__ 47*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertiesChangeListener.idl> 48*b1cdbd2cSJim Jagielski#endif 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski//============================================================================= 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module beans { 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski//============================================================================= 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski/** provides access to multiple properties with a single call. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielskipublished interface XMultiPropertySet: com::sun::star::uno::XInterface 60*b1cdbd2cSJim Jagielski{ 61*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski /** @returns 64*b1cdbd2cSJim Jagielski the <type>XPropertySetInfo</type> interface, which describes 65*b1cdbd2cSJim Jagielski all properties of the object to which this interface belongs. 66*b1cdbd2cSJim Jagielski <const>NULL</const> is returned if the object cannot or will 67*b1cdbd2cSJim Jagielski not provide information about the properties. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @see XPropertySet::getPropertySetInfo 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski com::sun::star::beans::XPropertySetInfo getPropertySetInfo(); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** sets the values to the properties with the specified names. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski <p>The values of the properties must change before the bound 78*b1cdbd2cSJim Jagielski events are fired. The values of the constrained properties 79*b1cdbd2cSJim Jagielski should change after the vetoable events are fired and only if no 80*b1cdbd2cSJim Jagielski exception occured. Unknown properties are ignored. </p> 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @param aPropertyNames 83*b1cdbd2cSJim Jagielski specifies the names of the properties. All names must be unique. 84*b1cdbd2cSJim Jagielski This sequence must be alphabetically sorted. 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @param aValues 87*b1cdbd2cSJim Jagielski contains the new values of the properties. The order is the same 88*b1cdbd2cSJim Jagielski as in <var>aPropertyNames</var>. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski @throws IllegalArgumentException 91*b1cdbd2cSJim Jagielski if one of the new values cannot be converted to the type 92*b1cdbd2cSJim Jagielski of the underlying property by an identity or widening conversion. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @throws com::sun::star::lang:WrappedTargetException 95*b1cdbd2cSJim Jagielski if the implementation has an internal reason for the exception. 96*b1cdbd2cSJim Jagielski In this case the original exception is wrapped. 97*b1cdbd2cSJim Jagielski */ 98*b1cdbd2cSJim Jagielski void setPropertyValues( [in] sequence<string> aPropertyNames, 99*b1cdbd2cSJim Jagielski [in] sequence<any> aValues ) 100*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::PropertyVetoException, 101*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException, 102*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski /** @returns 107*b1cdbd2cSJim Jagielski a sequence of all values of the properties which are specified by their names. 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski <p>The order of the values in the returned sequence will be the same 110*b1cdbd2cSJim Jagielski as the order of the names in the argument. </p> 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski @param aPropertyNames 113*b1cdbd2cSJim Jagielski specifies the names of the properties. 114*b1cdbd2cSJim Jagielski This sequence must be alphabetically sorted. 115*b1cdbd2cSJim Jagielski */ 116*b1cdbd2cSJim Jagielski sequence<any> getPropertyValues( [in] sequence<string> aPropertyNames ); 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski /** adds an <type>XPropertiesChangeListener</type> to the 121*b1cdbd2cSJim Jagielski specified property with the specified names. 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski <p>The implementation can ignore the names of the properties 124*b1cdbd2cSJim Jagielski and fire the event on all properties. </p> 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski <p>It is suggested to allow multiple registration of the same listener, 127*b1cdbd2cSJim Jagielski thus for each time a listener is added, it has to be removed. 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski @param aPropertyNames 130*b1cdbd2cSJim Jagielski specifies the names of the properties. 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski @param xListener 133*b1cdbd2cSJim Jagielski contains the listener for the property change events. 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski @see removePropertiesChangeListener 136*b1cdbd2cSJim Jagielski */ 137*b1cdbd2cSJim Jagielski [oneway] void addPropertiesChangeListener( [in] sequence<string> aPropertyNames, 138*b1cdbd2cSJim Jagielski [in] com::sun::star::beans::XPropertiesChangeListener xListener ); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski /** removes an <type>XPropertiesChangeListener</type> from the listener list. 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski <p>It is a "noop" if the listener is not registered. </p> 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski <p>It is suggested to allow multiple registration of the same listener, 147*b1cdbd2cSJim Jagielski thus for each time a listener is added, it has to be removed. 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski @param 150*b1cdbd2cSJim Jagielski contains the listener to be removed. 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski @see addPropertiesChangeListener 153*b1cdbd2cSJim Jagielski */ 154*b1cdbd2cSJim Jagielski [oneway] void removePropertiesChangeListener( [in] com::sun::star::beans::XPropertiesChangeListener xListener ); 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 157*b1cdbd2cSJim Jagielski 158*b1cdbd2cSJim Jagielski /** fires a sequence of <type>PropertyChangeEvent</type>s to the specified 159*b1cdbd2cSJim Jagielski listener. 160*b1cdbd2cSJim Jagielski 161*b1cdbd2cSJim Jagielski @param aPropertynames 162*b1cdbd2cSJim Jagielski specifies the sorted names of the properties. 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski @param xListener 165*b1cdbd2cSJim Jagielski contains the listener for the property change events. 166*b1cdbd2cSJim Jagielski */ 167*b1cdbd2cSJim Jagielski [oneway] void firePropertiesChangeEvent( [in] sequence<string> aPropertyNames, 168*b1cdbd2cSJim Jagielski [in] com::sun::star::beans::XPropertiesChangeListener xListener ); 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski}; 171*b1cdbd2cSJim Jagielski 172*b1cdbd2cSJim Jagielski//============================================================================= 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski}; }; }; }; 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski#endif 177