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_NamedRange_idl__
25#define __com_sun_star_sheet_NamedRange_idl__
26
27#ifndef __com_sun_star_sheet_XNamedRange_idl__
28#include <com/sun/star/sheet/XNamedRange.idl>
29#endif
30
31#ifndef __com_sun_star_container_XNamed_idl__
32#include <com/sun/star/container/XNamed.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__
36#include <com/sun/star/sheet/XCellRangeReferrer.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** represents a named range in a spreadsheet document.
46
47	<p>In fact a named range is a named formula expression. A cell range
48	address is one possible content of a named range.</p>
49
50	@see com::sun::star::sheet::NamedRanges
51 */
52published service NamedRange
53{
54	//-------------------------------------------------------------------------
55
56	/** provides access to the settings of the named range.
57	 */
58	interface com::sun::star::sheet::XNamedRange;
59
60	//-------------------------------------------------------------------------
61
62	/** provides access to the cell range object referred by this named range.
63
64		<p>This works only, if the named range contains a single cell range
65		address.</p>
66	 */
67	interface com::sun::star::sheet::XCellRangeReferrer;
68
69    //-------------------------------------------------------------------------
70
71    /** returns the index used to refer to this name in token arrays.
72
73        <p>A token describing a defined name shall contain the op-code obtained
74        from the <const>FormulaMapGroupSpecialOffset::NAME</const> offset and
75        this index as data part.</p>
76
77        @see com::sun::star::sheet::FormulaToken
78        @see com::sun::star::sheet::FormulaMapGroupSpecialOffset::NAME
79
80        @since OOo 3.0
81     */
82    [optional, readonly, property] long TokenIndex;
83
84    //-------------------------------------------------------------------------
85
86    /** Determines if this defined name represents a shared formula.
87
88        <p>This special property shall not be used externally. It is used by
89        import and export filters for compatibility with spreadsheet
90        documents containing shared formulas. Shared formulas are shared
91        by several cells to save memory and to decrease file size.</p>
92
93        <p>A defined name with this property set will not appear in the user
94        interface of Calc, and its name will not appear in cell formulas. A
95        formula referring to this defined name will show the formula
96        definition contained in the name instead.</p>
97
98        @since OOo 3.0
99     */
100    [optional, property] boolean IsSharedFormula;
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108
109