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

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