xref: /trunk/main/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_form_validation_ValidatableBindableControlModel_idl__
#define __com_sun_star_form_validation_ValidatableBindableControlModel_idl__

#ifndef __com_sun_star_form_validation_ValidatableControlModel_idl__
#include <com/sun/star/form/validation/ValidatableControlModel.idl>
#endif

#ifndef __com_sun_star_form_binding_BindableControlModel_idl__
#include <com/sun/star/form/binding/BindableControlModel.idl>
#endif
//=============================================================================

module com {  module sun {  module star {  module form { module validation {

/** specifies a control model which supports both binding to an external value supplier,
    and to an external validator.

    <p>There are two methods how the value which is represented by a control model
    can interact with other components (well, except the trivial ones accessible
    by using <type scope="com::sun::star::beans">XPropertySet</type>):
    <ul><li>binding the value to an external component via <type scope="com::sun::star::form::binding">XBindableValue</type></li>
        <li>validating the current value by an external component, via <type>XValidatable</type> and <type>XValidator</type></li>
    </ul></p>

    <p>The <type>ValidatableBindableControlModel</type> services describes the interaction of these concepts
    for control models which support both of them.</p>
*/
service ValidatableBindableControlModel
{
    /** specifies support for validating the current value of the control
    */
    service ValidatableControlModel;

    /** specifies support for binding the control value to an external component

        <p>If a value binding is established at the control model (by using
        <member scope="com::sun::star::form::binding">XBindableValue::setValueBinding</member> with a non-<NULL/>
        binding), this binding is analyzed for validation support. If it is present (read: if the
        binding also supports the <type>XValidator</type> interface), the binding is also
        established as validator, as if it has been passed to <member>XValidatable::setValidator</member>.<br/>
        If, while this binding is active (in both its roles as value binding and validator),
        an attempt is made to establish another validator, this is blocked with raising a
        <type scope="com::sun::star::util">VetoException</type> upon calling <member>XValidatable::setValidator</member>.</p>
    */
    service com::sun::star::form::binding::BindableControlModel;
};

//=============================================================================

}; }; }; }; };

#endif