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