xref: /aoo42x/main/offapi/com/sun/star/xforms/Binding.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_xforms_Binding_idl__
24#define __com_sun_star_xforms_Binding_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_form_binding_ValueBinding_idl__
31#include <com/sun/star/form/binding/ValueBinding.idl>
32#endif
33
34#ifndef __com_sun_star_form_binding_ListEntrySource_idl__
35#include <com/sun/star/form/binding/ListEntrySource.idl>
36#endif
37
38#ifndef __com_sun_star_form_validation_XValidator_idl__
39#include <com/sun/star/form/validation/XValidator.idl>
40#endif
41
42//=============================================================================
43
44module com {  module sun {  module star {  module xforms {
45
46interface XSubmission;
47
48//=============================================================================
49
50/** represent a binding to one or more nodes in the DOM tree of an <type>XModel</type>.
51 */
52service Binding
53{
54    /** allows the binding to act as value supplier for a form component
55
56    @see com::sun::star::form::binding::BindableControlModel
57    */
58    service com::sun::star::form::binding::ValueBinding;
59
60    /** allows external instances to observe the value represented by the binding
61
62        <p>This interface is an optional part of the
63        <type scope="com::sun::star::form::binding">ValueBinding</type> servce, but loses
64        its optionality here.</p>
65    */
66    interface com::sun::star::util::XModifyBroadcaster;
67
68    /** allows the binding to act as source for list entries of form controls
69
70        <p>If a binding is associated with more than one node in a DOM tree, it
71        does not represent a single value, but a list of values. Using this interface,
72        this list can be displayed in form control list and combo boxes.</p>
73    */
74    service com::sun::star::form::binding::ListEntrySource;
75
76    /** allows the binding to act as validator for a form component
77
78    @see com::sun::star::form::binding::ValidatableControlModel
79    */
80    interface com::sun::star::form::validation::XValidator;
81};
82
83//=============================================================================
84
85}; }; }; };
86
87/*=============================================================================
88
89=============================================================================*/
90#endif
91