1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_beans_XFastPropertyState_idl__ 24cdf0e10cSrcweir#define __com_sun_star_beans_XFastPropertyState_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyState_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/PropertyState.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 35cdf0e10cSrcweir#include <com/sun/star/beans/UnknownPropertyException.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweirmodule com { module sun { module star { module beans { 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweir/** makes it possible to query information about the state of 50cdf0e10cSrcweir one or more properties. 51cdf0e10cSrcweir 52cdf0e10cSrcweir <p>The state contains the information if:</p> 53cdf0e10cSrcweir <ul> 54cdf0e10cSrcweir <li>a value is available or void</li> 55cdf0e10cSrcweir <li>the value is stored in the object itself, or if a default value is to be used</li> 56cdf0e10cSrcweir <li>and if the value cannot be determined, due to ambiguity 57cdf0e10cSrcweir (multi selection with multiple values).</li> 58cdf0e10cSrcweir </ul> 59cdf0e10cSrcweir */ 60cdf0e10cSrcweirinterface XFastPropertyState: ::com::sun::star::uno::XInterface 61cdf0e10cSrcweir{ 62cdf0e10cSrcweir //------------------------------------------------------------------------- 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** @returns 65cdf0e10cSrcweir the state of the property. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @param aPropertyName 68cdf0e10cSrcweir specifies the name of the property. 69cdf0e10cSrcweir 70cdf0e10cSrcweir @throws UnknownPropertyException 71cdf0e10cSrcweir if the property does not exist. 72cdf0e10cSrcweir */ 73cdf0e10cSrcweir ::com::sun::star::beans::PropertyState getFastPropertyState( [in] long nHandle ) 74cdf0e10cSrcweir raises( ::com::sun::star::beans::UnknownPropertyException ); 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** @returns 79cdf0e10cSrcweir a sequence of the states of the properties which are specified 80cdf0e10cSrcweir by their names. 81cdf0e10cSrcweir 82cdf0e10cSrcweir <p>The order of the states is correlating to the order of the 83cdf0e10cSrcweir given property names. </p> 84cdf0e10cSrcweir 85cdf0e10cSrcweir @param aPropertyNames 86cdf0e10cSrcweir contains the sequence of property names. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @throws UnknownPropertyException 89cdf0e10cSrcweir if one property does not exist. 90cdf0e10cSrcweir */ 91cdf0e10cSrcweir sequence< ::com::sun::star::beans::PropertyState > getFastPropertyStates( 92cdf0e10cSrcweir [in] sequence< long > aHandles ) 93cdf0e10cSrcweir raises( ::com::sun::star::beans::UnknownPropertyException ); 94cdf0e10cSrcweir 95cdf0e10cSrcweir //------------------------------------------------------------------------- 96cdf0e10cSrcweir 97cdf0e10cSrcweir /** Sets the property to default value. 98cdf0e10cSrcweir 99cdf0e10cSrcweir <p>The value depends on the implementation of this interface. 100cdf0e10cSrcweir If it is a bound property, you must change the value before 101cdf0e10cSrcweir the change events are fired. If it is a constrained property, you 102cdf0e10cSrcweir must fire the vetoable event before you change the property value. 103cdf0e10cSrcweir </p> 104cdf0e10cSrcweir 105cdf0e10cSrcweir @param aPropertyname 106cdf0e10cSrcweir specifies the name of the property. 107cdf0e10cSrcweir 108cdf0e10cSrcweir @throws UnknownPropertyException 109cdf0e10cSrcweir if the property does not exist. 110cdf0e10cSrcweir */ 111cdf0e10cSrcweir void setFastPropertyToDefault( [in] long nHandle ) 112cdf0e10cSrcweir raises( ::com::sun::star::beans::UnknownPropertyException ); 113cdf0e10cSrcweir 114cdf0e10cSrcweir //------------------------------------------------------------------------- 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** @returns 117cdf0e10cSrcweir the default value of the property with the name PropertyName. 118cdf0e10cSrcweir 119cdf0e10cSrcweir <p>If no default exists, is not known or is void, 120cdf0e10cSrcweir then the return type is <type>void</type>. 121cdf0e10cSrcweir 122cdf0e10cSrcweir @param aPropertyName 123cdf0e10cSrcweir specifies the name of the property. 124cdf0e10cSrcweir 125cdf0e10cSrcweir @throws UnknownPropertyException 126cdf0e10cSrcweir if the property does not exist. 127cdf0e10cSrcweir 128cdf0e10cSrcweir @throws ::com::sun::star::lang::WrappedTargetException 129cdf0e10cSrcweir if the implementation has an internal reason for the exception. 130cdf0e10cSrcweir In this case the original exception is wrapped into that 131cdf0e10cSrcweir <type scope="::com::sun::star::lang">WrappedTargetException</type>. 132cdf0e10cSrcweir */ 133cdf0e10cSrcweir any getFastPropertyDefault( [in] long nHandle ) 134cdf0e10cSrcweir raises( ::com::sun::star::beans::UnknownPropertyException, 135cdf0e10cSrcweir ::com::sun::star::lang::WrappedTargetException ); 136cdf0e10cSrcweir}; 137cdf0e10cSrcweir 138cdf0e10cSrcweir//============================================================================= 139cdf0e10cSrcweir 140cdf0e10cSrcweir}; }; }; }; 141cdf0e10cSrcweir 142cdf0e10cSrcweir#endif 143