offapi/com/sun/star/form/binding/XBindableValue.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: XBindableValue.idl,v $
  10  * $Revision: 1.4 $
  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_XBindableValue_idl__
  32 #define __com_sun_star_form_binding_XBindableValue_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_form_binding_IncompatibleTypesException_idl__
  38 #include <com/sun/star/form/binding/IncompatibleTypesException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module form { module binding {
  44
  45 interface XValueBinding;
  46
  47 //=============================================================================
  48
  49 /** specifies support for being bound to an external value
  50
  51     @see XValueBinding
  52 */
  53 interface XBindableValue : com::sun::star::uno::XInterface
  54 {
  55     /** sets an external instance which controls the value of the component
  56
  57         <p>Any previously active binding will be revoked. There can be only one!</p>
  58
  59         @param aBinding
  60             the new binding which is to be used by the component. May be <NULL/>,
  61             in this case only the current binding is revoked.
  62
  63         @throws <type>IncompatibleTypesException</type>
  64             if the new binding (provided it's not <NULL/>) supports only types
  65             which are incompatible with the types of the bindable component.
  66      */
  67     void    setValueBinding( [in] XValueBinding aBinding )
  68                 raises ( IncompatibleTypesException );
  69
  70     /** retrieves the external instance which currently controls the value of the
  71         component
  72     */
  73     XValueBinding
  74             getValueBinding( );
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; }; };
  80
  81 #endif