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_XConsolidationDescriptor_idl__
25#define __com_sun_star_sheet_XConsolidationDescriptor_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_GeneralFunction_idl__
32#include <com/sun/star/sheet/GeneralFunction.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellRangeAddress_idl__
36#include <com/sun/star/table/CellRangeAddress.idl>
37#endif
38
39#ifndef __com_sun_star_table_CellAddress_idl__
40#include <com/sun/star/table/CellAddress.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** provides access to the settings of a consolidation descriptor.
50
51	@deprecated
52
53	@see com::sun::star::sheet::ConsolidationDescriptor
54 */
55published interface XConsolidationDescriptor: com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58
59	/** returns the function by which the ranges are consolidated.
60	 */
61	com::sun::star::sheet::GeneralFunction getFunction();
62
63	//-------------------------------------------------------------------------
64
65	/** sets the function by which the ranges are consolidated.
66	 */
67	void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction );
68
69	//-------------------------------------------------------------------------
70
71	/** returns the cell ranges which are consolidated.
72	 */
73	sequence< com::sun::star::table::CellRangeAddress > getSources();
74
75	//-------------------------------------------------------------------------
76
77	/** sets the cell ranges which are consolidated.
78	 */
79	void setSources(
80			[in] sequence< com::sun::star::table::CellRangeAddress > aSources );
81
82	//-------------------------------------------------------------------------
83
84	/** returns the position of the top left cell of the cell range where
85		the consolidated data are copied.
86	 */
87	com::sun::star::table::CellAddress getStartOutputPosition();
88
89	//-------------------------------------------------------------------------
90
91	/** sets the position of the top left cell of the cell range
92		where the consolidated data are copied.
93	 */
94	void setStartOutputPosition(
95			[in] com::sun::star::table::CellAddress aStartOutputPosition );
96
97	//-------------------------------------------------------------------------
98
99	/** returns, whether column headers from the cell ranges are used to
100		find matching data or not.
101	 */
102	boolean getUseColumnHeaders();
103
104	//-------------------------------------------------------------------------
105
106	/** specifies if column headers from the cell ranges are used to find
107		matching data.
108	 */
109	void setUseColumnHeaders( [in] boolean bUseColumnHeaders );
110
111	//-------------------------------------------------------------------------
112
113	/** returns, whether row headers from the cell ranges are used to
114		find matching data or not.
115	 */
116	boolean getUseRowHeaders();
117
118	//-------------------------------------------------------------------------
119
120	/** specifies if row headers from the cell ranges are used to find
121		matching data.
122	 */
123	void setUseRowHeaders( [in] boolean bUseRowHeaders );
124
125	//-------------------------------------------------------------------------
126
127	/** returns, whether links to the original data are inserted in the
128		output area or not.
129	 */
130	boolean getInsertLinks();
131
132	//-------------------------------------------------------------------------
133
134	/** specifies if links to the original data are inserted in the
135		output area.
136	 */
137	void setInsertLinks( [in] boolean bInsertLinks );
138
139};
140
141//=============================================================================
142
143}; }; }; };
144
145#endif
146
147