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_CellBindingPropertyHandler_idl__
25#define __com_sun_star_form_inspection_CellBindingPropertyHandler_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 is able to provide properties to bind a form component to a spreadsheet cell.
39
40    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
41    That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
42    <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
43    value denotes a spreadsheet document (indicated by supporting the <type scope="com::sun::star::sheet">XSpreadsheetDocument</type>
44    interface), this document is used to create the <type scope="com::sun::star::form::binding">ValueBinding</type>s
45    to bind the inspected object to cells in this document.</p>
46
47    @see com::sun::star::inspection::XPropertyHandler
48    @see com::sun::star::form::binding::BindableControlModel
49    @see com::sun::star::form::binding::ValueBinding
50    @see com::sun::star::table::CellValueBinding
51    @see com::sun::star::table::ListPositionCellBinding
52    @see com::sun::star::uno::XComponentContext::getValueByName
53*/
54service CellBindingPropertyHandler
55{
56    interface com::sun::star::inspection::XPropertyHandler;
57};
58
59//=============================================================================
60
61}; }; }; }; };
62
63#endif
64
65