1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyState_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_beans_XPropertyState_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyState_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/beans/PropertyState.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/beans/UnknownPropertyException.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 43*cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 44*cdf0e10cSrcweir#endif 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyStateChangeListener_idl__ 47*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyStateChangeListener.idl> 48*cdf0e10cSrcweir#endif 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir//============================================================================= 52*cdf0e10cSrcweir 53*cdf0e10cSrcweirmodule com { module sun { module star { module beans { 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir//============================================================================= 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir/** makes it possible to query information about the state of 58*cdf0e10cSrcweir one or more properties. 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir <p>The state contains the information if:</p> 61*cdf0e10cSrcweir <ul> 62*cdf0e10cSrcweir <li>a value is available or void</li> 63*cdf0e10cSrcweir <li>the value is stored in the object itself, or if a default value is to be used</li> 64*cdf0e10cSrcweir <li>and if the value cannot be determined, due to ambiguity 65*cdf0e10cSrcweir (multi selection with multiple values).</li> 66*cdf0e10cSrcweir </ul> 67*cdf0e10cSrcweir */ 68*cdf0e10cSrcweirpublished interface XPropertyState: com::sun::star::uno::XInterface 69*cdf0e10cSrcweir{ 70*cdf0e10cSrcweir //------------------------------------------------------------------------- 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** @returns 73*cdf0e10cSrcweir the state of the property. 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir @param aPropertyName 76*cdf0e10cSrcweir specifies the name of the property. 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir @throws UnknownPropertyException 79*cdf0e10cSrcweir if the property does not exist. 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir com::sun::star::beans::PropertyState getPropertyState( [in] string PropertyName ) 82*cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException ); 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir //------------------------------------------------------------------------- 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir /** @returns 87*cdf0e10cSrcweir a sequence of the states of the properties which are specified 88*cdf0e10cSrcweir by their names. 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir <p>The order of the states is correlating to the order of the 91*cdf0e10cSrcweir given property names. </p> 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir @param aPropertyNames 94*cdf0e10cSrcweir contains the sequence of property names. 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir @throws UnknownPropertyException 97*cdf0e10cSrcweir if one property does not exist. 98*cdf0e10cSrcweir */ 99*cdf0e10cSrcweir sequence<com::sun::star::beans::PropertyState> getPropertyStates( 100*cdf0e10cSrcweir [in] sequence<string> aPropertyName ) 101*cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException ); 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir //------------------------------------------------------------------------- 104*cdf0e10cSrcweir 105*cdf0e10cSrcweir /** Sets the property to default value. 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir <p>The value depends on the implementation of this interface. 108*cdf0e10cSrcweir If it is a bound property, you must change the value before 109*cdf0e10cSrcweir the change events are fired. If it is a constrained property, you 110*cdf0e10cSrcweir must fire the vetoable event before you change the property value. 111*cdf0e10cSrcweir </p> 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir @param aPropertyname 114*cdf0e10cSrcweir specifies the name of the property. 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir @throws UnknownPropertyException 117*cdf0e10cSrcweir if the property does not exist. 118*cdf0e10cSrcweir */ 119*cdf0e10cSrcweir void setPropertyToDefault( [in] string PropertyName ) 120*cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException ); 121*cdf0e10cSrcweir 122*cdf0e10cSrcweir //------------------------------------------------------------------------- 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir /** @returns 125*cdf0e10cSrcweir the default value of the property with the name PropertyName. 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir <p>If no default exists, is not known or is void, 128*cdf0e10cSrcweir then the return type is <atom>void</atom>. 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir @param aPropertyName 131*cdf0e10cSrcweir specifies the name of the property. 132*cdf0e10cSrcweir 133*cdf0e10cSrcweir @throws UnknownPropertyException 134*cdf0e10cSrcweir if the property does not exist. 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 137*cdf0e10cSrcweir if the implementation has an internal reason for the exception. 138*cdf0e10cSrcweir In this case the original exception is wrapped into that 139*cdf0e10cSrcweir <type scope="com::sun::star::lang">WrappedTargetException</type>. 140*cdf0e10cSrcweir */ 141*cdf0e10cSrcweir any getPropertyDefault( [in] string aPropertyName ) 142*cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException, 143*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 144*cdf0e10cSrcweir}; 145*cdf0e10cSrcweir 146*cdf0e10cSrcweir//============================================================================= 147*cdf0e10cSrcweir 148*cdf0e10cSrcweir}; }; }; }; 149*cdf0e10cSrcweir 150*cdf0e10cSrcweir#endif 151