offapi/com/sun/star/form/validation/ValidatableBindableControlModel.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 module com {  module sun {  module star {  module form { module validation {
  21
  22 /** specifies a control model which supports both binding to an external value supplier,
  23     and to an external validator.
  24
  25     <p>There are two methods how the value which is represented by a control model
  26     can interact with other components (well, except the trivial ones accessible
  27     by using com::sun::star::beans::XPropertySet):
  28     <ul><li>binding the value to an external component via com::sun::star::form::binding::XBindableValue</li>
  29         <li>validating the current value by an external component, via XValidatable and XValidator</li>
  30     </ul></p>
  31
  32     <p>The ValidatableBindableControlModel services describes the interaction of these concepts
  33     for control models which support both of them.</p>
  34 */
  35 service ValidatableBindableControlModel
  36 {
  37     /** specifies support for validating the current value of the control
  38     */
  39     service ValidatableControlModel;
  40
  41     /** specifies support for binding the control value to an external component
  42
  43         <p>If a value binding is established at the control model (by using
  44         com::sun::star::form::binding::XBindableValue::setValueBinding() with a non-`NULL`
  45         binding), this binding is analyzed for validation support. If it is present (read: if the
  46         binding also supports the XValidator interface), the binding is also
  47         established as validator, as if it has been passed to XValidatable::setValidator().<br/>
  48         If, while this binding is active (in both its roles as value binding and validator),
  49         an attempt is made to establish another validator, this is blocked with raising a
  50         com::sun::star::util::VetoException upon calling XValidatable::setValidator().</p>
  51     */
  52     service com::sun::star::form::binding::BindableControlModel;
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */