offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ValidatableBindableControlModel.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_validation_ValidatableBindableControlModel_idl__
  32 #define __com_sun_star_form_validation_ValidatableBindableControlModel_idl__
  33
  34 #ifndef __com_sun_star_form_validation_ValidatableControlModel_idl__
  35 #include <com/sun/star/form/validation/ValidatableControlModel.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_binding_BindableControlModel_idl__
  39 #include <com/sun/star/form/binding/BindableControlModel.idl>
  40 #endif
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module form { module validation {
  44
  45 /** specifies a control model which supports both binding to an external value supplier,
  46     and to an external validator.
  47
  48     <p>There are two methods how the value which is represented by a control model
  49     can interact with other components (well, except the trivial ones accessible
  50     by using <type scope="com::sun::star::beans">XPropertySet</type>):
  51     <ul><li>binding the value to an external component via <type scope="com::sun::star::form::binding">XBindableValue</type></li>
  52         <li>validating the current value by an external component, via <type>XValidatable</type> and <type>XValidator</type></li>
  53     </ul></p>
  54
  55     <p>The <type>ValidatableBindableControlModel</type> services describes the interaction of these concepts
  56     for control models which support both of them.</p>
  57 */
  58 service ValidatableBindableControlModel
  59 {
  60     /** specifies support for validating the current value of the control
  61     */
  62     service ValidatableControlModel;
  63
  64     /** specifies support for binding the control value to an external component
  65
  66         <p>If a value binding is established at the control model (by using
  67         <member scope="com::sun::star::form::binding">XBindableValue::setValueBinding</member> with a non-<NULL/>
  68         binding), this binding is analyzed for validation support. If it is present (read: if the
  69         binding also supports the <type>XValidator</type> interface), the binding is also
  70         established as validator, as if it has been passed to <member>XValidatable::setValidator</member>.<br/>
  71         If, while this binding is active (in both its roles as value binding and validator),
  72         an attempt is made to establish another validator, this is blocked with raising a
  73         <type scope="com::sun::star::util">VetoException</type> upon calling <member>XValidatable::setValidator</member>.</p>
  74     */
  75     service com::sun::star::form::binding::BindableControlModel;
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; }; };
  81
  82 #endif