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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_form_binding_XBindableValue_idl__
  21 #define __com_sun_star_form_binding_XBindableValue_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/form/binding/IncompatibleTypesException.idl>
  25
  26
  27 module com {  module sun {  module star {  module form { module binding {
  28
  29 interface XValueBinding;
  30
  31
  32 /** specifies support for being bound to an external value
  33
  34     @see XValueBinding
  35 */
  36 interface XBindableValue : com::sun::star::uno::XInterface
  37 {
  38     /** sets an external instance which controls the value of the component
  39
  40         <p>Any previously active binding will be revoked. There can be only one!</p>
  41
  42         @param aBinding
  43             the new binding which is to be used by the component. May be <NULL/>,
  44             in this case only the current binding is revoked.
  45
  46         @throws <type>IncompatibleTypesException</type>
  47             if the new binding (provided it's not <NULL/>) supports only types
  48             which are incompatible with the types of the bindable component.
  49      */
  50     void    setValueBinding( [in] XValueBinding aBinding )
  51                 raises ( IncompatibleTypesException );
  52
  53     /** retrieves the external instance which currently controls the value of the
  54         component
  55     */
  56     XValueBinding
  57             getValueBinding( );
  58 };
  59
  60
  61 }; }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */