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_XPropertyWithState_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_beans_XPropertyWithState_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_lang_WrappedTargetException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module beans { 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski//============================================================================= 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski/** makes it possible to query information about the state of 45*b1cdbd2cSJim Jagielski this object, seen as a property contained in a property set. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski <p> This interface provides direct access to operations 48*b1cdbd2cSJim Jagielski that are available if the containing property set 49*b1cdbd2cSJim Jagielski implements <type>XPropertyState</type>. 50*b1cdbd2cSJim Jagielski </p> 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p>The state contains the information if:</p> 53*b1cdbd2cSJim Jagielski <ul> 54*b1cdbd2cSJim Jagielski <li>a value is available or void</li> 55*b1cdbd2cSJim Jagielski <li>the value is stored in the object itself, or if a default value is being used</li> 56*b1cdbd2cSJim Jagielski <li>or if the value cannot be determined, due to ambiguity 57*b1cdbd2cSJim Jagielski (multi selection with multiple values).</li> 58*b1cdbd2cSJim Jagielski </ul> 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski <p> Generally objects that implement this interface 61*b1cdbd2cSJim Jagielski also implement <type>XProperty</type>. 62*b1cdbd2cSJim Jagielski </p> 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielskipublished interface XPropertyWithState: com::sun::star::uno::XInterface 65*b1cdbd2cSJim Jagielski{ 66*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** @returns 69*b1cdbd2cSJim Jagielski the state of this as a property. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski com::sun::star::beans::PropertyState getStateAsProperty( ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** sets this to its default value. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski <p> The value depends on the implementation of this interface. 78*b1cdbd2cSJim Jagielski If this is a bound property, the value changes before 79*b1cdbd2cSJim Jagielski the change events are fired. If this is a constrained property, 80*b1cdbd2cSJim Jagielski the vetoable event is fired before the property value changes. 81*b1cdbd2cSJim Jagielski </p> 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 84*b1cdbd2cSJim Jagielski if the implementation has an internal reason for the exception. 85*b1cdbd2cSJim Jagielski In this case the original exception is wrapped into that 86*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">WrappedTargetException</type>. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski void setToDefaultAsProperty( ) 89*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::WrappedTargetException ); 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski /** @returns 94*b1cdbd2cSJim Jagielski an object representing the default state of this object (as a property). 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski <p> If no default exists, is not known or is void, 97*b1cdbd2cSJim Jagielski then the return value is <NULL/>. 98*b1cdbd2cSJim Jagielski </p> 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 101*b1cdbd2cSJim Jagielski if the implementation has an internal reason for the exception. 102*b1cdbd2cSJim Jagielski In this case the original exception is wrapped into that 103*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">WrappedTargetException</type>. 104*b1cdbd2cSJim Jagielski */ 105*b1cdbd2cSJim Jagielski com::sun::star::uno::XInterface getDefaultAsProperty( ) 106*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::WrappedTargetException ); 107*b1cdbd2cSJim Jagielski}; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski//============================================================================= 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski}; }; }; }; 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski#endif 114