offapi/com/sun/star/table/CellValueBinding.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: CellValueBinding.idl,v $
  10  * $Revision: 1.4 $
  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_table_CellValueBinding_idl__
  32 #define __com_sun_star_table_CellValueBinding_idl__
  33
  34 #ifndef __com_sun_star_form_binding_ValueBinding_idl__
  35 #include <com/sun/star/form/binding/ValueBinding.idl>
  36 #endif
  37 #ifndef __com_sun_star_table_CellAddress_idl__
  38 #include <com/sun/star/table/CellAddress.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_XInitialization_idl__
  41 #include <com/sun/star/lang/XInitialization.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com {  module sun {  module star {  module table {
  47
  48 //=============================================================================
  49
  50 /** defines the binding to a single cell in a table document
  51
  52     <p>Read/Write access to the cell represented by this component is supported,
  53     as well as active broadcasting of value changes.</p>
  54
  55     <p>The binding supports exchanging <em>double</em> values, <em>string</em>
  56     values.</p>
  57
  58     <p>The component cannot be instantiated at a global service factory, instead
  59     it's usually provided by a document instance.</p>
  60
  61     @see com::sun::star::document::OfficeDocument
  62 */
  63 service CellValueBinding
  64 {
  65     /** ensures the basic functionality for binding to a value
  66     */
  67     service com::sun::star::form::binding::ValueBinding;
  68
  69     /** specifies the cell within a document whose value is reflected
  70         by the binding.
  71     */
  72     [property, bound, readonly] com::sun::star::table::CellAddress  BoundCell;
  73
  74     /** allows notifications of changes in the content of the underlying cell.
  75
  76         <p>Note that this interface is already optionally allowed in the
  77         underlying service (<type scope="com::sun::star::form::binding">ValueBinding</type>),
  78         but it loses it's optionality here.</p>
  79     */
  80     interface com::sun::star::util::XModifyBroadcaster;
  81
  82     /** allows setting initial, creation-time properties of the component
  83
  84         <p>This interface is used to initialize the component after creation. It has
  85         to be used exactly once in the life time of the component, every second call
  86         to <member scope"com::sun::star::lang">XInitialization::initialize</member>
  87         will throw an exception.</p>
  88
  89         <p>The arguments passed to the <member scope"com::sun::star::lang">XInitialization::initialize</member>
  90         method must be instances of <type scope="com::sun::star::beans">NamedValue</type>, where
  91         the <member scope"com::sun::star::beans">NamedValue::Name</member> denotes the type of information
  92         to initialize, and the <member scope"com::sun::star::beans">NamedValue::Value</member>
  93         the inital value.</p>
  94
  95         <p>The following aspects of the components can be initialized:<br/>
  96             <ul><li><b>BoundCell</b><br/>
  97                 specifies the address of the cell to bind this instance to. Must be a
  98                 <type scope="com::sun::star::table">CellAddress</type> instance.</li>
  99             </ul>
 100         </p>
 101     */
 102     interface com::sun::star::lang::XInitialization;
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 #endif