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