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