1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_binding_BindableControlModel_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_form_binding_BindableControlModel_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_binding_XBindableValue_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/form/binding/XBindableValue.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_FormControlModel_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/form/FormControlModel.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module form { module binding { 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski/** specifies the model of a form control which supports binding to an external 39*b1cdbd2cSJim Jagielski value supplier. 40*b1cdbd2cSJim Jagielski*/ 41*b1cdbd2cSJim Jagielskiservice BindableControlModel 42*b1cdbd2cSJim Jagielski{ 43*b1cdbd2cSJim Jagielski /** specifies the basic functionality for a form control model 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski <p>Via this service, bindable control models inherit the 46*b1cdbd2cSJim Jagielski <type scope="com::sun::star::util">XCloneable</type> interface.<br/> 47*b1cdbd2cSJim Jagielski If an bindable control model, at which a binding has been established (via 48*b1cdbd2cSJim Jagielski <member>XBindableValue::setValueBinding</member>), is being cloned, then the 49*b1cdbd2cSJim Jagielski binding is also established at the clone. Effectively, this means that 50*b1cdbd2cSJim Jagielski both control model instances share the same binding instance.</p> 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski service com::sun::star::form::FormControlModel; 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** specifies support for being bound to an external value 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski <p>When a <type>BindableControlModel</type> is bound to an external value, 57*b1cdbd2cSJim Jagielski then every change in the control model's value is <em>immediately</em> reflected 58*b1cdbd2cSJim Jagielski in the external binding.</p> 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski <p>If the binding set via this interface supports the <member>ValueBinding::ReadOnly</member> 61*b1cdbd2cSJim Jagielski and <member>ValueBinding::Relevant</member> properties, they're respected by the control model: 62*b1cdbd2cSJim Jagielski <ul><li>The control model's own <code>ReadOnly</code> property (if present) is kept in sync with the 63*b1cdbd2cSJim Jagielski binding's <code>ReadOnly</code> property. That is, any control using the value 64*b1cdbd2cSJim Jagielski binding is read-only as long as the binding is.</li> 65*b1cdbd2cSJim Jagielski <li>The control model's own <code>Enabled</code> property (if present) is kept in sync 66*b1cdbd2cSJim Jagielski with the binding's <code>Relevant</code> property. That is, any control using 67*b1cdbd2cSJim Jagielski the value binding is disabled as long as the binding is not relevant.</li> 68*b1cdbd2cSJim Jagielski </ul> 69*b1cdbd2cSJim Jagielski </p> 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski <p>In both cases, explicit changes of the model's property are ignored if they would relax 72*b1cdbd2cSJim Jagielski the restriction imposed by the binding.<br/> 73*b1cdbd2cSJim Jagielski For instance, if the binding declares it's value to 74*b1cdbd2cSJim Jagielski be read-only (indicated by <member>ValueBinding::ReadOnly</member> being <TRUE/>), then 75*b1cdbd2cSJim Jagielski any attempt to set the <code>ReadOnly</code> property of the control model to <FALSE/> will 76*b1cdbd2cSJim Jagielski fail. However, if the binding's value is not read-only, then the <code>ReadOnly</code> 77*b1cdbd2cSJim Jagielski property at the control model can be freely set.<br/> 78*b1cdbd2cSJim Jagielski The very same holds for the binding's <member>ValueBinding::Relevant</member> and the control 79*b1cdbd2cSJim Jagielski model's <code>Enabled</code> properties.</p> 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski interface XBindableValue; 82*b1cdbd2cSJim Jagielski}; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski//============================================================================= 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski}; }; }; }; }; 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski#endif 89