1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10*408a4873SAndrew Rist * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*408a4873SAndrew Rist * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19*408a4873SAndrew Rist * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_beans_XMultiPropertyState_idl__ 24cdf0e10cSrcweir#define __com_sun_star_beans_XMultiPropertyState_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#ifndef __com_sun_star_beans_XPropertyStateChangeListener_idl__ 43cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyStateChangeListener.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweirmodule com { module sun { module star { module beans { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir/** makes it possible to query information about the state of 53cdf0e10cSrcweir one or more properties. 54cdf0e10cSrcweir 55cdf0e10cSrcweir <p>The state of a property contains information about the source of 56cdf0e10cSrcweir the value, e.g. the object itself, a default or a stylesheet. 57cdf0e10cSrcweir For more information see <type>PropertyState</type>. 58cdf0e10cSrcweir*/ 59cdf0e10cSrcweirpublished interface XMultiPropertyStates: com::sun::star::uno::XInterface 60cdf0e10cSrcweir{ 61cdf0e10cSrcweir //------------------------------------------------------------------------- 62cdf0e10cSrcweir /** @returns 63cdf0e10cSrcweir a sequence of the states of the properties which are specified 64cdf0e10cSrcweir by their names. 65cdf0e10cSrcweir 66cdf0e10cSrcweir <p>The order of the states is correlating to the order of the 67cdf0e10cSrcweir given property names. 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param aPropertyName 70cdf0e10cSrcweir specifies the names of the properties. All names must be unique. 71cdf0e10cSrcweir This sequence must be alphabetically sorted. 72cdf0e10cSrcweir */ 73cdf0e10cSrcweir sequence<com::sun::star::beans::PropertyState> getPropertyStates( 74cdf0e10cSrcweir [in] sequence<string> aPropertyName ) 75cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException ); 76cdf0e10cSrcweir 77cdf0e10cSrcweir //------------------------------------------------------------------------- 78cdf0e10cSrcweir /** sets all properties to their default values. 79cdf0e10cSrcweir 80cdf0e10cSrcweir <p>Each value depends on the implementation of this interface. 81cdf0e10cSrcweir If it is a bound property, you must change the value before 82cdf0e10cSrcweir the change events are fired. If it is a constrained property, you 83cdf0e10cSrcweir must fire the vetoable event before you change the property value. 84cdf0e10cSrcweir </p> 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir void setAllPropertiesToDefault(); 87cdf0e10cSrcweir 88cdf0e10cSrcweir //------------------------------------------------------------------------- 89cdf0e10cSrcweir /** sets the specified properties to their default values. 90cdf0e10cSrcweir 91cdf0e10cSrcweir <p>Each value depends on the implementation of this interface. 92cdf0e10cSrcweir If it is a bound property, you must change the value before 93cdf0e10cSrcweir the change events are fired. If it is a constrained property, you 94cdf0e10cSrcweir must fire the vetoable event before you change the property value. </p> 95cdf0e10cSrcweir 96cdf0e10cSrcweir @param aPropertyName 97cdf0e10cSrcweir specifies the names of the properties. All names must be unique. 98cdf0e10cSrcweir This sequence must be alphabetically sorted. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @throws UnknownPropertyException 101cdf0e10cSrcweir if one of the properties does not exist. 102cdf0e10cSrcweir */ 103cdf0e10cSrcweir void setPropertiesToDefault( [in] sequence<string> aPropertyNames ) 104cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException ); 105cdf0e10cSrcweir 106cdf0e10cSrcweir //------------------------------------------------------------------------- 107cdf0e10cSrcweir /** @returns 108cdf0e10cSrcweir the default values of the propertes with the specified names. 109cdf0e10cSrcweir 110cdf0e10cSrcweir <p>If no default exists, is not known, or is void, 111cdf0e10cSrcweir then the return type at the corresponding position in the 112cdf0e10cSrcweir sequence returned is <atom>void</atom>. </p> 113cdf0e10cSrcweir 114cdf0e10cSrcweir @param aPropertyName 115cdf0e10cSrcweir specifies the names of the properties. All names must be unique. 116cdf0e10cSrcweir This sequence must be alphabetically sorted. 117cdf0e10cSrcweir 118cdf0e10cSrcweir @throws UnknownPropertyException 119cdf0e10cSrcweir if one of the propertes does not exist. 120cdf0e10cSrcweir 121cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 122cdf0e10cSrcweir if the implementation has an internal reason for the exception. 123cdf0e10cSrcweir In this case the original exception is wrapped into that 124cdf0e10cSrcweir <type scope="com::sun::star::lang">WrappedTargetException</type>. 125cdf0e10cSrcweir */ 126cdf0e10cSrcweir sequence<any> getPropertyDefaults( 127cdf0e10cSrcweir [in] sequence<string> aPropertyNames ) 128cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException, 129cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 130cdf0e10cSrcweir}; 131cdf0e10cSrcweir 132cdf0e10cSrcweir//============================================================================= 133cdf0e10cSrcweir 134cdf0e10cSrcweir}; }; }; }; 135cdf0e10cSrcweir 136cdf0e10cSrcweir#endif 137