offapi/com/sun/star/form/binding/XValueBinding.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XValueBinding.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_binding_XValueBinding_idl__
  32 #define __com_sun_star_form_binding_XValueBinding_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_lang_NoSupportException_idl__
  38 #include <com/sun/star/lang/NoSupportException.idl>
  39 #endif
  40 #ifndef __com_sun_star_form_binding_IncompatibleTypesException_idl__
  41 #include <com/sun/star/form/binding/IncompatibleTypesException.idl>
  42 #endif
  43 #ifndef __com_sun_star_form_binding_InvalidBindingStateException_idl__
  44 #include <com/sun/star/form/binding/InvalidBindingStateException.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module form { module binding {
  50
  51 //=============================================================================
  52
  53 /** specifies a binding to a value which can be read and written.
  54 */
  55 interface XValueBinding : com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** determines the types which are supported by this binding for value exchange
  59
  60         @see supportsType
  61     */
  62     sequence< type >
  63             getSupportedValueTypes( );
  64
  65     /** determines whether a given type is supported by this binding for value exchange
  66
  67         <p>Calling this method is equal to calling <member>getSupportedValueTypes</member>,
  68         and looking up the given type in the resulting type sequence.</p>
  69
  70         @see getSupportedValueTypes
  71     */
  72     boolean supportsType( [in] type aType );
  73
  74     /** retrieves the current value
  75
  76         @throws <type>IncompatibleTypesException</type>
  77             if the requested value type is not supported by the binding
  78         @see getSupportedValueTypes
  79         @see supportsType
  80     */
  81     any     getValue( [in] type aType )
  82                 raises( IncompatibleTypesException );
  83
  84     /** sets the current value
  85
  86         @throws <type>IncompatibleTypesException</type>
  87             if the given value type is not supported by the binding
  88         @throws <type>InvalidBindingStateException</type>
  89             if the value currently cannot be changed, since the binding is not
  90             fully operational. Possible reasons for this include the binding being
  91             readonly, or the target of the binding not being present.
  92         @throws <type scope="com::sun::star::lang">NoSupportException</type>
  93             if the binding in general does not support write access to it's binding
  94
  95         @see getSupportedValueTypes
  96         @see supportsType
  97         @see ValueBinding
  98     */
  99     void    setValue( [in] any aValue )
 100                 raises( IncompatibleTypesException, InvalidBindingStateException, com::sun::star::lang::NoSupportException );
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; }; };
 106
 107 #endif