offapi/com/sun/star/table/CellValueBinding.idl

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