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