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_XMultiPropertyState_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_beans_XMultiPropertyState_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#ifndef __com_sun_star_beans_XPropertyStateChangeListener_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertyStateChangeListener.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module beans { 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski//============================================================================= 52*b1cdbd2cSJim Jagielski/** makes it possible to query information about the state of 53*b1cdbd2cSJim Jagielski one or more properties. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski <p>The state of a property contains information about the source of 56*b1cdbd2cSJim Jagielski the value, e.g. the object itself, a default or a stylesheet. 57*b1cdbd2cSJim Jagielski For more information see <type>PropertyState</type>. 58*b1cdbd2cSJim Jagielski*/ 59*b1cdbd2cSJim Jagielskipublished interface XMultiPropertyStates: com::sun::star::uno::XInterface 60*b1cdbd2cSJim Jagielski{ 61*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 62*b1cdbd2cSJim Jagielski /** @returns 63*b1cdbd2cSJim Jagielski a sequence of the states of the properties which are specified 64*b1cdbd2cSJim Jagielski by their names. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski <p>The order of the states is correlating to the order of the 67*b1cdbd2cSJim Jagielski given property names. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @param aPropertyName 70*b1cdbd2cSJim Jagielski specifies the names of the properties. All names must be unique. 71*b1cdbd2cSJim Jagielski This sequence must be alphabetically sorted. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski sequence<com::sun::star::beans::PropertyState> getPropertyStates( 74*b1cdbd2cSJim Jagielski [in] sequence<string> aPropertyName ) 75*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 78*b1cdbd2cSJim Jagielski /** sets all properties to their default values. 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski <p>Each value depends on the implementation of this interface. 81*b1cdbd2cSJim Jagielski If it is a bound property, you must change the value before 82*b1cdbd2cSJim Jagielski the change events are fired. If it is a constrained property, you 83*b1cdbd2cSJim Jagielski must fire the vetoable event before you change the property value. 84*b1cdbd2cSJim Jagielski </p> 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski void setAllPropertiesToDefault(); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 89*b1cdbd2cSJim Jagielski /** sets the specified properties to their default values. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski <p>Each value depends on the implementation of this interface. 92*b1cdbd2cSJim Jagielski If it is a bound property, you must change the value before 93*b1cdbd2cSJim Jagielski the change events are fired. If it is a constrained property, you 94*b1cdbd2cSJim Jagielski must fire the vetoable event before you change the property value. </p> 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @param aPropertyName 97*b1cdbd2cSJim Jagielski specifies the names of the properties. All names must be unique. 98*b1cdbd2cSJim Jagielski This sequence must be alphabetically sorted. 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 101*b1cdbd2cSJim Jagielski if one of the properties does not exist. 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski void setPropertiesToDefault( [in] sequence<string> aPropertyNames ) 104*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException ); 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 107*b1cdbd2cSJim Jagielski /** @returns 108*b1cdbd2cSJim Jagielski the default values of the propertes with the specified names. 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski <p>If no default exists, is not known, or is void, 111*b1cdbd2cSJim Jagielski then the return type at the corresponding position in the 112*b1cdbd2cSJim Jagielski sequence returned is <atom>void</atom>. </p> 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski @param aPropertyName 115*b1cdbd2cSJim Jagielski specifies the names of the properties. All names must be unique. 116*b1cdbd2cSJim Jagielski This sequence must be alphabetically sorted. 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski @throws UnknownPropertyException 119*b1cdbd2cSJim Jagielski if one of the propertes does not exist. 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 122*b1cdbd2cSJim Jagielski if the implementation has an internal reason for the exception. 123*b1cdbd2cSJim Jagielski In this case the original exception is wrapped into that 124*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">WrappedTargetException</type>. 125*b1cdbd2cSJim Jagielski */ 126*b1cdbd2cSJim Jagielski sequence<any> getPropertyDefaults( 127*b1cdbd2cSJim Jagielski [in] sequence<string> aPropertyNames ) 128*b1cdbd2cSJim Jagielski raises( com::sun::star::beans::UnknownPropertyException, 129*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException ); 130*b1cdbd2cSJim Jagielski}; 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski//============================================================================= 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski}; }; }; }; 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski#endif 137