offapi/com/sun/star/table/CellRangeListSource.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_CellRangeListSource_idl__
  21 #define __com_sun_star_table_CellRangeListSource_idl__
  22
  23 #include <com/sun/star/form/binding/ListEntrySource.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25 #include <com/sun/star/lang/XInitialization.idl>
  26
  27
  28 module com {  module sun {  module star {  module table {
  29
  30
  31
  32 /** defines the a source of list entries coming from a cell range in a table document
  33
  34     <p>The component cannot be instantiated at a global service factory, instead
  35     it's usually provided by a document instance.</p>
  36
  37     @see com::sun::star::document::OfficeDocument
  38 */
  39 service CellRangeListSource
  40 {
  41     /** ensures the basic functionality for supplying list entries
  42     */
  43     service com::sun::star::form::binding::ListEntrySource;
  44
  45     /** specifies the cell range within a document to which the component
  46         is bound.
  47     */
  48     [property, bound, readonly] com::sun::star::table::CellRangeAddress CellRange;
  49
  50     /** allows setting initial, creation-time properties of the component
  51
  52         <p>This interface is used to initialize the component after creation. It has
  53         to be used exactly once in the life time of the component, every second call
  54         to com::sun::star::lang::XInitialization::initialize()
  55         will throw an exception.</p>
  56
  57         <p>The arguments passed to the
  58         com::sun::star::lang::XInitialization::initialize()
  59         method must be instances of com::sun::star::beans::NamedValue, where
  60         the com::sun::star::beans::NamedValue::Name denotes the type of
  61         information to initialize, and the
  62         com::sun::star::beans::NamedValue::Value
  63         the initial value.</p>
  64
  65         <p>The following aspects of the components can be initialized:<br/>
  66             <ul><li><b>CellRange</b><br/>
  67                 specifies the address of the cell range to bind this instance to. Must be a
  68                 com::sun::star::table::CellRangeAddress instance.</li>
  69             </ul>
  70         </p>
  71     */
  72     interface com::sun::star::lang::XInitialization;
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */