summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl
blob: c80ff50ae532a91ab7f2d039589c088d3a9ab86c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/**
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__
#define __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__

#include <com/sun/star/inspection/XPropertyHandler.idl>


module com {  module sun {  module star {  module form { module inspection {


/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
    which is able to provide properties to bind a form component to a spreadsheet cell.

    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
    That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
    <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
    value denotes a spreadsheet document (indicated by supporting the <type scope="com::sun::star::sheet">XSpreadsheetDocument</type>
    interface), this document is used to create the <type scope="com::sun::star::form::binding">ValueBinding</type>s
    to bind the inspected object to cells in this document.</p>

    @see com::sun::star::inspection::XPropertyHandler
    @see com::sun::star::form::binding::BindableControlModel
    @see com::sun::star::form::binding::ValueBinding
    @see com::sun::star::table::CellValueBinding
    @see com::sun::star::table::ListPositionCellBinding
    @see com::sun::star::uno::XComponentContext::getValueByName
*/
service CellBindingPropertyHandler
{
    interface com::sun::star::inspection::XPropertyHandler;
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */