1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__
29#define __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__
30
31#ifndef __com_sun_star_inspection_XPropertyHandler_idl__
32#include <com/sun/star/inspection/XPropertyHandler.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module form { module inspection {
38
39//=============================================================================
40
41/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
42    which is able to provide properties to bind a form component to a spreadsheet cell.
43
44    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
45    That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
46    <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
47    value denotes a spreadsheet document (indicated by supporting the <type scope="com::sun::star::sheet">XSpreadsheetDocument</type>
48    interface), this document is used to create the <type scope="com::sun::star::form::binding">ValueBinding</type>s
49    to bind the inspected object to cells in this document.</p>
50
51    @see com::sun::star::inspection::XPropertyHandler
52    @see com::sun::star::form::binding::BindableControlModel
53    @see com::sun::star::form::binding::ValueBinding
54    @see com::sun::star::table::CellValueBinding
55    @see com::sun::star::table::ListPositionCellBinding
56    @see com::sun::star::uno::XComponentContext::getValueByName
57*/
58service CellBindingPropertyHandler
59{
60    interface com::sun::star::inspection::XPropertyHandler;
61};
62
63//=============================================================================
64
65}; }; }; }; };
66
67#endif
68
69