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_XNamedRange_idl__
25#define __com_sun_star_sheet_XNamedRange_idl__
26
27#ifndef __com_sun_star_container_XNamed_idl__
28#include <com/sun/star/container/XNamed.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellAddress_idl__
32#include <com/sun/star/table/CellAddress.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access to the settings of a named range in a spreadsheet
42	document.
43
44	@see com::sun::star::sheet::NamedRange
45 */
46published interface XNamedRange: com::sun::star::container::XNamed
47{
48	//-------------------------------------------------------------------------
49
50	/** returns the content of the named range.
51
52		<p>The content can be a reference to a cell or cell range
53		or any formula expression.</p>
54	 */
55	string getContent();
56
57	//-------------------------------------------------------------------------
58
59	/** sets the content of the named range.
60
61		<p>The content can be a reference to a cell or cell range
62		or any formula expression.</p>
63	 */
64	void setContent( [in] string aContent );
65
66	//-------------------------------------------------------------------------
67
68	/** returns the position in the document which is used as a
69		base for relative references in the content.
70	 */
71	com::sun::star::table::CellAddress getReferencePosition();
72
73	//-------------------------------------------------------------------------
74
75	/** sets the position in the document which is used as a
76		base for relative references in the content.
77	 */
78	void setReferencePosition(
79			[in] com::sun::star::table::CellAddress aReferencePosition );
80
81	//-------------------------------------------------------------------------
82
83	/** returns the type of the named range.
84
85		<p>This is a combination of flags as defined in
86		<type>NamedRangeFlag</type>.</p>
87	 */
88	long getType();
89
90	//-------------------------------------------------------------------------
91
92	/** sets the type of the named range.
93
94		@param nType
95			a combination of flags that specify the type of a named range,
96			as defined in <type>NamedRangeFlag</type>.
97	 */
98	void setType( [in] long nType );
99
100};
101
102//=============================================================================
103
104}; }; }; };
105
106#endif
107
108