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
24#ifndef __com_sun_star_form_inspection_XMLFormsPropertyHandler_idl__
25#define __com_sun_star_form_inspection_XMLFormsPropertyHandler_idl__
26
27#ifndef __com_sun_star_inspection_XPropertyHandler_idl__
28#include <com/sun/star/inspection/XPropertyHandler.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module form { module inspection {
34
35//=============================================================================
36
37/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
38    which provides properties related to binding form control models to XForm bindings.
39
40    <p>The handler introduces new properties to choose an <type scope="com::sun::star::xforms">XModel</type>
41    and a <type scope="com::sun::star::xforms">Binding</type> within this model. Additionally,
42    it introduces properties which reflect the different facets of the binding (e.g.
43    <member scope="com::sun::star::xforms">Binding::BindingExpression</member>), so they can be changed
44    directly in the <type scope="com::sun::star::inspection">ObjectInspector</type> as if they were a
45    property of the form component which is being inspected.</p>
46
47    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
48    That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
49    <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
50    value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type>
51    interface), this document is used to do XML binding related work.</p>
52
53    @see com::sun::star::inspection::XPropertyHandler
54    @see com::sun::star::form::binding::BindableControlModel
55    @see com::sun::star::form::binding::ValueBinding
56    @see com::sun::star::xforms::Binding
57    @see com::sun::star::uno::XComponentContext::getValueByName
58*/
59service XMLFormsPropertyHandler
60{
61    interface com::sun::star::inspection::XPropertyHandler;
62};
63
64//=============================================================================
65
66}; }; }; }; };
67
68#endif
69
70