1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_CellRangeListSource_idl__
29#define __com_sun_star_sheet_CellRangeListSource_idl__
30
31#ifndef __com_sun_star_form_binding_ListEntrySource_idl__
32#include <com/sun/star/form/binding/ListEntrySource.idl>
33#endif
34#ifndef __com_sun_star_table_CellRangeAddress_idl__
35#include <com/sun/star/table/CellRangeAddress.idl>
36#endif
37#ifndef __com_sun_star_lang_XInitialization_idl__
38#include <com/sun/star/lang/XInitialization.idl>
39#endif
40
41//=============================================================================
42
43module com {  module sun {  module star {  module table {
44
45
46//=============================================================================
47
48/** defines the a source of list entries coming from a cell range in a tbale document
49
50    <p>The component cannot be instantiated at a global service factory, instead
51    it's usually provided by a document instance.</p>
52
53    @see com::sun::star::document::OfficeDocument
54*/
55service CellRangeListSource
56{
57    /** ensures the basic functionality for supplying list entries
58    */
59    service com::sun::star::form::binding::ListEntrySource;
60
61    /** specifies the cell range within a document to which the component
62        is bound.
63    */
64    [property, bound, readonly] com::sun::star::table::CellRangeAddress CellRange;
65
66    /** allows setting initial, creation-time properties of the component
67
68        <p>This interface is used to initialize the component after creation. It has
69        to be used exactly once in the life time of the component, every second call
70        to <member scope"com::sun::star::lang">XInitialization::initialize</member>
71        will throw an exception.</p>
72
73        <p>The arguments passed to the <member scope"com::sun::star::lang">XInitialization::initialize</member>
74        method must be instances of <type scope="com::sun::star::beans">NamedValue</type>, where
75        the <member scope"com::sun::star::beans">NamedValue::Name</member> denotes the type of information
76        to initialize, and the <member scope"com::sun::star::beans">NamedValue::Value</member>
77        the inital value.</p>
78
79        <p>The following aspects of the components can be initialized:<br/>
80            <ul><li><b>CellRange</b><br/>
81                specifies the address of the cell range to bind this instance to. Must be a
82                <type scope="com::sun::star::table">CellRangeAddress</type> instance.</li>
83            </ul>
84        </p>
85    */
86    interface com::sun::star::lang::XInitialization;
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94