1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_table_CellValueBinding_idl__ 25#define __com_sun_star_table_CellValueBinding_idl__ 26 27#ifndef __com_sun_star_form_binding_ValueBinding_idl__ 28#include <com/sun/star/form/binding/ValueBinding.idl> 29#endif 30#ifndef __com_sun_star_table_CellAddress_idl__ 31#include <com/sun/star/table/CellAddress.idl> 32#endif 33#ifndef __com_sun_star_lang_XInitialization_idl__ 34#include <com/sun/star/lang/XInitialization.idl> 35#endif 36 37//============================================================================= 38 39module com { module sun { module star { module table { 40 41//============================================================================= 42 43/** defines the binding to a single cell in a table document 44 45 <p>Read/Write access to the cell represented by this component is supported, 46 as well as active broadcasting of value changes.</p> 47 48 <p>The binding supports exchanging <em>double</em> values, <em>string</em> 49 values.</p> 50 51 <p>The component cannot be instantiated at a global service factory, instead 52 it's usually provided by a document instance.</p> 53 54 @see com::sun::star::document::OfficeDocument 55*/ 56service CellValueBinding 57{ 58 /** ensures the basic functionality for binding to a value 59 */ 60 service com::sun::star::form::binding::ValueBinding; 61 62 /** specifies the cell within a document whose value is reflected 63 by the binding. 64 */ 65 [property, bound, readonly] com::sun::star::table::CellAddress BoundCell; 66 67 /** allows notifications of changes in the content of the underlying cell. 68 69 <p>Note that this interface is already optionally allowed in the 70 underlying service (<type scope="com::sun::star::form::binding">ValueBinding</type>), 71 but it loses it's optionality here.</p> 72 */ 73 interface com::sun::star::util::XModifyBroadcaster; 74 75 /** allows setting initial, creation-time properties of the component 76 77 <p>This interface is used to initialize the component after creation. It has 78 to be used exactly once in the life time of the component, every second call 79 to <member scope"com::sun::star::lang">XInitialization::initialize</member> 80 will throw an exception.</p> 81 82 <p>The arguments passed to the <member scope"com::sun::star::lang">XInitialization::initialize</member> 83 method must be instances of <type scope="com::sun::star::beans">NamedValue</type>, where 84 the <member scope"com::sun::star::beans">NamedValue::Name</member> denotes the type of information 85 to initialize, and the <member scope"com::sun::star::beans">NamedValue::Value</member> 86 the initial value.</p> 87 88 <p>The following aspects of the components can be initialized:<br/> 89 <ul><li><b>BoundCell</b><br/> 90 specifies the address of the cell to bind this instance to. Must be a 91 <type scope="com::sun::star::table">CellAddress</type> instance.</li> 92 </ul> 93 </p> 94 */ 95 interface com::sun::star::lang::XInitialization; 96}; 97 98//============================================================================= 99 100}; }; }; }; 101 102#endif 103