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