diff options
Diffstat (limited to 'offapi/com/sun/star/form/binding/BindableControlModel.idl')
| -rw-r--r-- | offapi/com/sun/star/form/binding/BindableControlModel.idl | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/binding/BindableControlModel.idl b/offapi/com/sun/star/form/binding/BindableControlModel.idl new file mode 100644 index 000000000..809c8a64c --- /dev/null +++ b/offapi/com/sun/star/form/binding/BindableControlModel.idl @@ -0,0 +1,80 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_form_binding_BindableControlModel_idl__ +#define __com_sun_star_form_binding_BindableControlModel_idl__ + +#include <com/sun/star/form/binding/XBindableValue.idl> +#include <com/sun/star/form/FormControlModel.idl> + + +module com { module sun { module star { module form { module binding { + +/** specifies the model of a form control which supports binding to an external + value supplier. +*/ +service BindableControlModel +{ + /** specifies the basic functionality for a form control model + + <p>Via this service, bindable control models inherit the + com::sun::star::util::XCloneable interface.<br/> + If a bindable control model, at which a binding has been established (via + XBindableValue::setValueBinding()), is being cloned, then the + binding is also established at the clone. Effectively, this means that + both control model instances share the same binding instance.</p> + */ + service com::sun::star::form::FormControlModel; + + /** specifies support for being bound to an external value + + <p>When a BindableControlModel is bound to an external value, + then every change in the control model's value is <em>immediately</em> reflected + in the external binding.</p> + + <p>If the binding set via this interface supports the ValueBinding::ReadOnly + and ValueBinding::Relevant properties, they're respected by the control model: + <ul><li>The control model's own <code>ReadOnly</code> property (if present) is kept in sync with the + binding's <code>ReadOnly</code> property. That is, any control using the value + binding is read-only as long as the binding is.</li> + <li>The control model's own <code>Enabled</code> property (if present) is kept in sync + with the binding's <code>Relevant</code> property. That is, any control using + the value binding is disabled as long as the binding is not relevant.</li> + </ul> + </p> + + <p>In both cases, explicit changes of the model's property are ignored if they would relax + the restriction imposed by the binding.<br/> + For instance, if the binding declares its value to + be read-only (indicated by ValueBinding::ReadOnly being `TRUE`), then + any attempt to set the <code>ReadOnly</code> property of the control model to `FALSE` will + fail. However, if the binding's value is not read-only, then the <code>ReadOnly</code> + property at the control model can be freely set.<br/> + The very same holds for the binding's ValueBinding::Relevant and the control + model's <code>Enabled</code> properties.</p> + */ + interface XBindableValue; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |