From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- .../sun/star/form/binding/BindableControlModel.idl | 80 ++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 offapi/com/sun/star/form/binding/BindableControlModel.idl (limited to 'offapi/com/sun/star/form/binding/BindableControlModel.idl') 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 +#include + + +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 + +

Via this service, bindable control models inherit the + com::sun::star::util::XCloneable interface.
+ 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.

+ */ + service com::sun::star::form::FormControlModel; + + /** specifies support for being bound to an external value + +

When a BindableControlModel is bound to an external value, + then every change in the control model's value is immediately reflected + in the external binding.

+ +

If the binding set via this interface supports the ValueBinding::ReadOnly + and ValueBinding::Relevant properties, they're respected by the control model: +

  • The control model's own ReadOnly property (if present) is kept in sync with the + binding's ReadOnly property. That is, any control using the value + binding is read-only as long as the binding is.
  • +
  • The control model's own Enabled property (if present) is kept in sync + with the binding's Relevant property. That is, any control using + the value binding is disabled as long as the binding is not relevant.
  • +
+

+ +

In both cases, explicit changes of the model's property are ignored if they would relax + the restriction imposed by the binding.
+ For instance, if the binding declares its value to + be read-only (indicated by ValueBinding::ReadOnly being `TRUE`), then + any attempt to set the ReadOnly property of the control model to `FALSE` will + fail. However, if the binding's value is not read-only, then the ReadOnly + property at the control model can be freely set.
+ The very same holds for the binding's ValueBinding::Relevant and the control + model's Enabled properties.

+ */ + interface XBindableValue; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3