offapi/com/sun/star/form/binding/BindableControlModel.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
  21 module com {  module sun {  module star {  module form { module binding {
  22
  23 /** specifies the model of a form control which supports binding to an external
  24     value supplier.
  25 */
  26 service BindableControlModel
  27 {
  28     /** specifies the basic functionality for a form control model
  29
  30         <p>Via this service, bindable control models inherit the
  31         com::sun::star::util::XCloneable interface.<br/>
  32         If a bindable control model, at which a binding has been established (via
  33         XBindableValue::setValueBinding()), is being cloned, then the
  34         binding is also established at the clone. Effectively, this means that
  35         both control model instances share the same binding instance.</p>
  36     */
  37     service com::sun::star::form::FormControlModel;
  38
  39     /** specifies support for being bound to an external value
  40
  41         <p>When a BindableControlModel is bound to an external value,
  42         then every change in the control model's value is <em>immediately</em> reflected
  43         in the external binding.</p>
  44
  45         <p>If the binding set via this interface supports the ValueBinding::ReadOnly
  46         and ValueBinding::Relevant properties, they're respected by the control model:
  47         <ul><li>The control model's own <code>ReadOnly</code> property (if present) is kept in sync with the
  48                 binding's <code>ReadOnly</code> property. That is, any control using the value
  49                 binding is read-only as long as the binding is.</li>
  50             <li>The control model's own <code>Enabled</code> property (if present) is kept in sync
  51                 with the binding's <code>Relevant</code> property. That is, any control using
  52                 the value binding is disabled as long as the binding is not relevant.</li>
  53         </ul>
  54         </p>
  55
  56         <p>In both cases, explicit changes of the model's property are ignored if they would relax
  57         the restriction imposed by the binding.<br/>
  58         For instance, if the binding declares its value to
  59         be read-only (indicated by ValueBinding::ReadOnly being `TRUE`), then
  60         any attempt to set the <code>ReadOnly</code> property of the control model to `FALSE` will
  61         fail. However, if the binding's value is not read-only, then the <code>ReadOnly</code>
  62         property at the control model can be freely set.<br/>
  63         The very same holds for the binding's ValueBinding::Relevant and the control
  64         model's <code>Enabled</code> properties.</p>
  65     */
  66     interface XBindableValue;
  67 };
  68
  69
  70 }; }; }; }; };
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */