offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__
  21 #define __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__
  22
  23 #include <com/sun/star/inspection/XPropertyHandler.idl>
  24
  25
  26 module com {  module sun {  module star {  module form { module inspection {
  27
  28
  29 /** implements a property handler for use with an com::sun::star::inspection::ObjectInspector
  30     which is able to provide properties to bind a form component to a spreadsheet cell.
  31
  32     <p>The handler expects a value named "ContextDocument" in the context in which it is created.
  33     That is, the com::sun::star::uno::XComponentContext used for creating the
  34     CellBindingPropertyHandler is examined for a value with this name. If the object in this
  35     value denotes a spreadsheet document (indicated by supporting the com::sun::star::sheet::XSpreadsheetDocument
  36     interface), this document is used to create the com::sun::star::form::binding::ValueBindings
  37     to bind the inspected object to cells in this document.</p>
  38
  39     @see com::sun::star::inspection::XPropertyHandler
  40     @see com::sun::star::form::binding::BindableControlModel
  41     @see com::sun::star::form::binding::ValueBinding
  42     @see com::sun::star::table::CellValueBinding
  43     @see com::sun::star::table::ListPositionCellBinding
  44     @see com::sun::star::uno::XComponentContext::getValueByName
  45 */
  46 service CellBindingPropertyHandler
  47 {
  48     interface com::sun::star::inspection::XPropertyHandler;
  49 };
  50
  51
  52 }; }; }; }; };
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */