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_XPropertySet_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_beans_XPropertySet_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_UnknownPropertyException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/UnknownPropertyException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_PropertyVetoException_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/PropertyVetoException.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 47*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 48*b1cdbd2cSJim Jagielski#endif 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__ 51*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertyChangeListener.idl> 52*b1cdbd2cSJim Jagielski#endif 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XVetoableChangeListener_idl__ 55*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XVetoableChangeListener.idl> 56*b1cdbd2cSJim Jagielski#endif 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski//============================================================================= 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module beans { 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski//============================================================================= 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski/** provides information about and access to the 66*b1cdbd2cSJim Jagielski properties from an implementation. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski <p>There are three types of properties: </p> 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski <ul> 71*b1cdbd2cSJim Jagielski <li>bound properties </li> 72*b1cdbd2cSJim Jagielski <li>constrained properties </li> 73*b1cdbd2cSJim Jagielski <li>free properties </li> 74*b1cdbd2cSJim Jagielski </ul> 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski <p>You can listen to changes of bound properties with the 77*b1cdbd2cSJim Jagielski <type>XPropertyChangeListener</type> and you can veto changes 78*b1cdbd2cSJim Jagielski of constrained properties with the <type>XVetoableChangeListener</type>. </p> 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski <p>To implement inaccurate name access, you must support the 81*b1cdbd2cSJim Jagielski interface <type>XExactName</type>. </p> 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @see com::sun::star::beans::XExactName 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielskipublished interface XPropertySet: com::sun::star::uno::XInterface 86*b1cdbd2cSJim Jagielski{ 87*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** @returns 90*b1cdbd2cSJim Jagielski the <type>XPropertySetInfo</type> interface, which 91*b1cdbd2cSJim Jagielski describes all properties of the object which supplies this 92*b1cdbd2cSJim Jagielski interface. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @returns 95*b1cdbd2cSJim Jagielski <const>NULL</const> if the implementation cannot or will 96*b1cdbd2cSJim Jagielski not provide information about the properties; otherwise the 97*b1cdbd2cSJim Jagielski interface <type>XPropertySetInfo</type> is returned. 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski com::sun::star::beans::XPropertySetInfo getPropertySetInfo(); 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski /** sets the value of the property with the specified name. 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski <p>If it is a bound property the value will be changed before 106*b1cdbd2cSJim Jagielski the change event is fired. If it is a constrained property 107*b1cdbd2cSJim Jagielski a vetoable event is fired before the property value can be 108*b1cdbd2cSJim Jagielski changed. </p> 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @throws com::sun::star::beans::PropertyVetoException 111*b1cdbd2cSJim Jagielski if the property is read-only or vetoable 112*b1cdbd2cSJim Jagielski and one of the listeners throws this exception 113*b1cdbd2cSJim Jagielski because of an unaccepted new value. 114*b1cdbd2cSJim Jagielski */ 115*b1cdbd2cSJim Jagielski void setPropertyValue( [in] string aPropertyName, 116*b1cdbd2cSJim Jagielski [in] any aValue ) 117*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 118*b1cdbd2cSJim Jagielski com::sun::star::beans::PropertyVetoException, 119*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException, 120*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski /** @returns 125*b1cdbd2cSJim Jagielski the value of the property with the specified name. 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski @param PropertyName 128*b1cdbd2cSJim Jagielski This parameter specifies the name of the property. 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 131*b1cdbd2cSJim Jagielski if the property does not exist. 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 134*b1cdbd2cSJim Jagielski if the implementation has an internal reason for the exception. 135*b1cdbd2cSJim Jagielski In this case the original exception is wrapped into that 136*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">WrappedTargetException</type>. 137*b1cdbd2cSJim Jagielski */ 138*b1cdbd2cSJim Jagielski any getPropertyValue( [in] string PropertyName ) 139*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 140*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski /** adds an <type>XPropertyChangeListener</type> to the specified property. 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski <p>An empty name ("") registers the listener to all bound 147*b1cdbd2cSJim Jagielski properties. If the property is not bound, the behavior is 148*b1cdbd2cSJim Jagielski not specified. </p> 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski <p>It is suggested to allow multiple registration of the same listener, 151*b1cdbd2cSJim Jagielski thus for each time a listener is added, it has to be removed. 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski @see removePropertyChangeListener 154*b1cdbd2cSJim Jagielski */ 155*b1cdbd2cSJim Jagielski void addPropertyChangeListener( [in] string aPropertyName, 156*b1cdbd2cSJim Jagielski [in] com::sun::star::beans::XPropertyChangeListener xListener ) 157*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 158*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski /** removes an <type>XPropertyChangeListener</type> from 163*b1cdbd2cSJim Jagielski the listener list. 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski <p>It is a "noop" if the listener is not registered. </p> 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski <p>It is suggested to allow multiple registration of the same listener, 168*b1cdbd2cSJim Jagielski thus for each time a listener is added, it has to be removed. 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski @see addPropertyChangeListener 171*b1cdbd2cSJim Jagielski */ 172*b1cdbd2cSJim Jagielski void removePropertyChangeListener( [in] string aPropertyName, 173*b1cdbd2cSJim Jagielski [in] com::sun::star::beans::XPropertyChangeListener aListener ) 174*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 175*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 176*b1cdbd2cSJim Jagielski 177*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski /** adds an <type>XVetoableChangeListener</type> to the specified 180*b1cdbd2cSJim Jagielski property with the name PropertyName. 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski <p>An empty name ("") registers the listener to all 183*b1cdbd2cSJim Jagielski constrained properties. If the property is not constrained, 184*b1cdbd2cSJim Jagielski the behavior is not specified. </p> 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski @see removeVetoableChangeListener 187*b1cdbd2cSJim Jagielski */ 188*b1cdbd2cSJim Jagielski void addVetoableChangeListener( [in] string PropertyName, 189*b1cdbd2cSJim Jagielski [in] com::sun::star::beans::XVetoableChangeListener aListener ) 190*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 191*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 192*b1cdbd2cSJim Jagielski 193*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski /** removes an <type>XVetoableChangeListener</type> from the 196*b1cdbd2cSJim Jagielski listener list. 197*b1cdbd2cSJim Jagielski 198*b1cdbd2cSJim Jagielski <p>It is a "noop" if the listener is not registered. </p> 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski @see addVetoableChangeListener 201*b1cdbd2cSJim Jagielski */ 202*b1cdbd2cSJim Jagielski void removeVetoableChangeListener( [in] string PropertyName, 203*b1cdbd2cSJim Jagielski [in] com::sun::star::beans::XVetoableChangeListener aListener ) 204*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 205*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 206*b1cdbd2cSJim Jagielski 207*b1cdbd2cSJim Jagielski}; 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski//============================================================================= 210*b1cdbd2cSJim Jagielski 211*b1cdbd2cSJim Jagielski}; }; }; }; 212*b1cdbd2cSJim Jagielski 213*b1cdbd2cSJim Jagielski#endif 214