1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_CellRangeListSource_idl__
25cdf0e10cSrcweir#define __com_sun_star_sheet_CellRangeListSource_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_form_binding_ListEntrySource_idl__
28cdf0e10cSrcweir#include <com/sun/star/form/binding/ListEntrySource.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir#ifndef __com_sun_star_table_CellRangeAddress_idl__
31cdf0e10cSrcweir#include <com/sun/star/table/CellRangeAddress.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir#ifndef __com_sun_star_lang_XInitialization_idl__
34cdf0e10cSrcweir#include <com/sun/star/lang/XInitialization.idl>
35cdf0e10cSrcweir#endif
36cdf0e10cSrcweir
37cdf0e10cSrcweir//=============================================================================
38cdf0e10cSrcweir
39cdf0e10cSrcweirmodule com {  module sun {  module star {  module table {
40cdf0e10cSrcweir
41cdf0e10cSrcweir
42cdf0e10cSrcweir//=============================================================================
43cdf0e10cSrcweir
44cdf0e10cSrcweir/** defines the a source of list entries coming from a cell range in a tbale document
45cdf0e10cSrcweir
46cdf0e10cSrcweir    <p>The component cannot be instantiated at a global service factory, instead
47cdf0e10cSrcweir    it's usually provided by a document instance.</p>
48cdf0e10cSrcweir
49cdf0e10cSrcweir    @see com::sun::star::document::OfficeDocument
50cdf0e10cSrcweir*/
51cdf0e10cSrcweirservice CellRangeListSource
52cdf0e10cSrcweir{
53cdf0e10cSrcweir    /** ensures the basic functionality for supplying list entries
54cdf0e10cSrcweir    */
55cdf0e10cSrcweir    service com::sun::star::form::binding::ListEntrySource;
56cdf0e10cSrcweir
57cdf0e10cSrcweir    /** specifies the cell range within a document to which the component
58cdf0e10cSrcweir        is bound.
59cdf0e10cSrcweir    */
60cdf0e10cSrcweir    [property, bound, readonly] com::sun::star::table::CellRangeAddress CellRange;
61cdf0e10cSrcweir
62cdf0e10cSrcweir    /** allows setting initial, creation-time properties of the component
63cdf0e10cSrcweir
64cdf0e10cSrcweir        <p>This interface is used to initialize the component after creation. It has
65cdf0e10cSrcweir        to be used exactly once in the life time of the component, every second call
66cdf0e10cSrcweir        to <member scope"com::sun::star::lang">XInitialization::initialize</member>
67cdf0e10cSrcweir        will throw an exception.</p>
68cdf0e10cSrcweir
69cdf0e10cSrcweir        <p>The arguments passed to the <member scope"com::sun::star::lang">XInitialization::initialize</member>
70cdf0e10cSrcweir        method must be instances of <type scope="com::sun::star::beans">NamedValue</type>, where
71cdf0e10cSrcweir        the <member scope"com::sun::star::beans">NamedValue::Name</member> denotes the type of information
72cdf0e10cSrcweir        to initialize, and the <member scope"com::sun::star::beans">NamedValue::Value</member>
73cdf0e10cSrcweir        the inital value.</p>
74cdf0e10cSrcweir
75cdf0e10cSrcweir        <p>The following aspects of the components can be initialized:<br/>
76cdf0e10cSrcweir            <ul><li><b>CellRange</b><br/>
77cdf0e10cSrcweir                specifies the address of the cell range to bind this instance to. Must be a
78cdf0e10cSrcweir                <type scope="com::sun::star::table">CellRangeAddress</type> instance.</li>
79cdf0e10cSrcweir            </ul>
80cdf0e10cSrcweir        </p>
81cdf0e10cSrcweir    */
82cdf0e10cSrcweir    interface com::sun::star::lang::XInitialization;
83cdf0e10cSrcweir};
84cdf0e10cSrcweir
85cdf0e10cSrcweir//=============================================================================
86cdf0e10cSrcweir
87cdf0e10cSrcweir}; }; }; };
88cdf0e10cSrcweir
89cdf0e10cSrcweir#endif
90