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