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_XFastPropertyState_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_beans_XFastPropertyState_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_PropertyState_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/PropertyState.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_lang_WrappedTargetException_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module beans { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski/** makes it possible to query information about the state of 50*b1cdbd2cSJim Jagielski one or more properties. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p>The state contains the information if:</p> 53*b1cdbd2cSJim Jagielski <ul> 54*b1cdbd2cSJim Jagielski <li>a value is available or void</li> 55*b1cdbd2cSJim Jagielski <li>the value is stored in the object itself, or if a default value is to be used</li> 56*b1cdbd2cSJim Jagielski <li>and if the value cannot be determined, due to ambiguity 57*b1cdbd2cSJim Jagielski (multi selection with multiple values).</li> 58*b1cdbd2cSJim Jagielski </ul> 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielskiinterface XFastPropertyState: ::com::sun::star::uno::XInterface 61*b1cdbd2cSJim Jagielski{ 62*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** @returns 65*b1cdbd2cSJim Jagielski the state of the property. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @param aPropertyName 68*b1cdbd2cSJim Jagielski specifies the name of the property. 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 71*b1cdbd2cSJim Jagielski if the property does not exist. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski ::com::sun::star::beans::PropertyState getFastPropertyState( [in] long nHandle ) 74*b1cdbd2cSJim Jagielski raises( ::com::sun::star::beans::UnknownPropertyException ); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** @returns 79*b1cdbd2cSJim Jagielski a sequence of the states of the properties which are specified 80*b1cdbd2cSJim Jagielski by their names. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski <p>The order of the states is correlating to the order of the 83*b1cdbd2cSJim Jagielski given property names. </p> 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @param aPropertyNames 86*b1cdbd2cSJim Jagielski contains the sequence of property names. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 89*b1cdbd2cSJim Jagielski if one property does not exist. 90*b1cdbd2cSJim Jagielski */ 91*b1cdbd2cSJim Jagielski sequence< ::com::sun::star::beans::PropertyState > getFastPropertyStates( 92*b1cdbd2cSJim Jagielski [in] sequence< long > aHandles ) 93*b1cdbd2cSJim Jagielski raises( ::com::sun::star::beans::UnknownPropertyException ); 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski /** Sets the property to default value. 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski <p>The value depends on the implementation of this interface. 100*b1cdbd2cSJim Jagielski If it is a bound property, you must change the value before 101*b1cdbd2cSJim Jagielski the change events are fired. If it is a constrained property, you 102*b1cdbd2cSJim Jagielski must fire the vetoable event before you change the property value. 103*b1cdbd2cSJim Jagielski </p> 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski @param aPropertyname 106*b1cdbd2cSJim Jagielski specifies the name of the property. 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 109*b1cdbd2cSJim Jagielski if the property does not exist. 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski void setFastPropertyToDefault( [in] long nHandle ) 112*b1cdbd2cSJim Jagielski raises( ::com::sun::star::beans::UnknownPropertyException ); 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** @returns 117*b1cdbd2cSJim Jagielski the default value of the property with the name PropertyName. 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski <p>If no default exists, is not known or is void, 120*b1cdbd2cSJim Jagielski then the return type is <type>void</type>. 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski @param aPropertyName 123*b1cdbd2cSJim Jagielski specifies the name of the property. 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 126*b1cdbd2cSJim Jagielski if the property does not exist. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::WrappedTargetException 129*b1cdbd2cSJim Jagielski if the implementation has an internal reason for the exception. 130*b1cdbd2cSJim Jagielski In this case the original exception is wrapped into that 131*b1cdbd2cSJim Jagielski <type scope="::com::sun::star::lang">WrappedTargetException</type>. 132*b1cdbd2cSJim Jagielski */ 133*b1cdbd2cSJim Jagielski any getFastPropertyDefault( [in] long nHandle ) 134*b1cdbd2cSJim Jagielski raises( ::com::sun::star::beans::UnknownPropertyException, 135*b1cdbd2cSJim Jagielski ::com::sun::star::lang::WrappedTargetException ); 136*b1cdbd2cSJim Jagielski}; 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski//============================================================================= 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski}; }; }; }; 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski#endif 143