offapi/com/sun/star/table/CellRangeListSource.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: CellRangeListSource.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_sheet_CellRangeListSource_idl__
  32 #define __com_sun_star_sheet_CellRangeListSource_idl__
  33
  34 #ifndef __com_sun_star_form_binding_ListEntrySource_idl__
  35 #include <com/sun/star/form/binding/ListEntrySource.idl>
  36 #endif
  37 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  38 #include <com/sun/star/table/CellRangeAddress.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
  51 /** defines the a source of list entries coming from a cell range in a tbale document
  52
  53     <p>The component cannot be instantiated at a global service factory, instead
  54     it's usually provided by a document instance.</p>
  55
  56     @see com::sun::star::document::OfficeDocument
  57 */
  58 service CellRangeListSource
  59 {
  60     /** ensures the basic functionality for supplying list entries
  61     */
  62     service com::sun::star::form::binding::ListEntrySource;
  63
  64     /** specifies the cell range within a document to which the component
  65         is bound.
  66     */
  67     [property, bound, readonly] com::sun::star::table::CellRangeAddress CellRange;
  68
  69     /** allows setting initial, creation-time properties of the component
  70
  71         <p>This interface is used to initialize the component after creation. It has
  72         to be used exactly once in the life time of the component, every second call
  73         to <member scope"com::sun::star::lang">XInitialization::initialize</member>
  74         will throw an exception.</p>
  75
  76         <p>The arguments passed to the <member scope"com::sun::star::lang">XInitialization::initialize</member>
  77         method must be instances of <type scope="com::sun::star::beans">NamedValue</type>, where
  78         the <member scope"com::sun::star::beans">NamedValue::Name</member> denotes the type of information
  79         to initialize, and the <member scope"com::sun::star::beans">NamedValue::Value</member>
  80         the inital value.</p>
  81
  82         <p>The following aspects of the components can be initialized:<br/>
  83             <ul><li><b>CellRange</b><br/>
  84                 specifies the address of the cell range to bind this instance to. Must be a
  85                 <type scope="com::sun::star::table">CellRangeAddress</type> instance.</li>
  86             </ul>
  87         </p>
  88     */
  89     interface com::sun::star::lang::XInitialization;
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif