1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_form_binding_XValueBinding_idl__ 25cdf0e10cSrcweir#define __com_sun_star_form_binding_XValueBinding_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir#ifndef __com_sun_star_lang_NoSupportException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/lang/NoSupportException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir#ifndef __com_sun_star_form_binding_IncompatibleTypesException_idl__ 34cdf0e10cSrcweir#include <com/sun/star/form/binding/IncompatibleTypesException.idl> 35cdf0e10cSrcweir#endif 36cdf0e10cSrcweir#ifndef __com_sun_star_form_binding_InvalidBindingStateException_idl__ 37cdf0e10cSrcweir#include <com/sun/star/form/binding/InvalidBindingStateException.idl> 38cdf0e10cSrcweir#endif 39cdf0e10cSrcweir 40cdf0e10cSrcweir//============================================================================= 41cdf0e10cSrcweir 42cdf0e10cSrcweirmodule com { module sun { module star { module form { module binding { 43cdf0e10cSrcweir 44cdf0e10cSrcweir//============================================================================= 45cdf0e10cSrcweir 46cdf0e10cSrcweir/** specifies a binding to a value which can be read and written. 47cdf0e10cSrcweir*/ 48cdf0e10cSrcweirinterface XValueBinding : com::sun::star::uno::XInterface 49cdf0e10cSrcweir{ 50cdf0e10cSrcweir //------------------------------------------------------------------------- 51cdf0e10cSrcweir /** determines the types which are supported by this binding for value exchange 52cdf0e10cSrcweir 53cdf0e10cSrcweir @see supportsType 54cdf0e10cSrcweir */ 55cdf0e10cSrcweir sequence< type > 56cdf0e10cSrcweir getSupportedValueTypes( ); 57cdf0e10cSrcweir 58cdf0e10cSrcweir /** determines whether a given type is supported by this binding for value exchange 59cdf0e10cSrcweir 60cdf0e10cSrcweir <p>Calling this method is equal to calling <member>getSupportedValueTypes</member>, 61cdf0e10cSrcweir and looking up the given type in the resulting type sequence.</p> 62cdf0e10cSrcweir 63cdf0e10cSrcweir @see getSupportedValueTypes 64cdf0e10cSrcweir */ 65cdf0e10cSrcweir boolean supportsType( [in] type aType ); 66cdf0e10cSrcweir 67cdf0e10cSrcweir /** retrieves the current value 68cdf0e10cSrcweir 69cdf0e10cSrcweir @throws <type>IncompatibleTypesException</type> 70cdf0e10cSrcweir if the requested value type is not supported by the binding 71cdf0e10cSrcweir @see getSupportedValueTypes 72cdf0e10cSrcweir @see supportsType 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir any getValue( [in] type aType ) 75cdf0e10cSrcweir raises( IncompatibleTypesException ); 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** sets the current value 78cdf0e10cSrcweir 79cdf0e10cSrcweir @throws <type>IncompatibleTypesException</type> 80cdf0e10cSrcweir if the given value type is not supported by the binding 81cdf0e10cSrcweir @throws <type>InvalidBindingStateException</type> 82cdf0e10cSrcweir if the value currently cannot be changed, since the binding is not 83cdf0e10cSrcweir fully operational. Possible reasons for this include the binding being 84cdf0e10cSrcweir readonly, or the target of the binding not being present. 85cdf0e10cSrcweir @throws <type scope="com::sun::star::lang">NoSupportException</type> 86cdf0e10cSrcweir if the binding in general does not support write access to it's binding 87cdf0e10cSrcweir 88cdf0e10cSrcweir @see getSupportedValueTypes 89cdf0e10cSrcweir @see supportsType 90cdf0e10cSrcweir @see ValueBinding 91cdf0e10cSrcweir */ 92cdf0e10cSrcweir void setValue( [in] any aValue ) 93cdf0e10cSrcweir raises( IncompatibleTypesException, InvalidBindingStateException, com::sun::star::lang::NoSupportException ); 94cdf0e10cSrcweir}; 95cdf0e10cSrcweir 96cdf0e10cSrcweir//============================================================================= 97cdf0e10cSrcweir 98cdf0e10cSrcweir}; }; }; }; }; 99cdf0e10cSrcweir 100cdf0e10cSrcweir#endif 101