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_XDatabaseRange_idl__
29#define __com_sun_star_sheet_XDatabaseRange_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_table_CellRangeAddress_idl__
36#include <com/sun/star/table/CellRangeAddress.idl>
37#endif
38
39#ifndef __com_sun_star_beans_PropertyValue_idl__
40#include <com/sun/star/beans/PropertyValue.idl>
41#endif
42
43#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
44#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
45#endif
46
47#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
48#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
49#endif
50
51//=============================================================================
52
53module com {  module sun {  module star {  module sheet {
54
55//=============================================================================
56
57/** provides access to the settings and options of a database range.
58
59	@see com::sun::star::sheet::DatabaseRange
60 */
61published interface XDatabaseRange: com::sun::star::uno::XInterface
62{
63	//-------------------------------------------------------------------------
64
65	/** returns the data area of the database range in the
66		spreadsheet document.
67	 */
68	com::sun::star::table::CellRangeAddress getDataArea();
69
70	//-------------------------------------------------------------------------
71
72	/** sets the data area of the database range.
73	 */
74	void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea );
75
76	//-------------------------------------------------------------------------
77
78	/** returns the sort descriptor stored with the database range.
79
80		@see SheetSortDescriptor2
81	 */
82	sequence< com::sun::star::beans::PropertyValue > getSortDescriptor();
83
84	//-------------------------------------------------------------------------
85
86	/** returns the filter descriptor stored with the database range.
87
88		<p>If the filter descriptor is modified, the new filtering is
89		carried out when <member>XDatabaseRange::refresh()</member> is
90		called.</p>
91
92		@see SheetFilterDescriptor
93	 */
94	XSheetFilterDescriptor getFilterDescriptor();
95
96	//-------------------------------------------------------------------------
97
98	/** returns the subtotal descriptor stored with the database range.
99
100		<p>If the subtotal descriptor is modified, the new subtotals are
101		inserted when <member>XDatabaseRange::refresh()</member> is
102		called.</p>
103
104		@see SubTotalDescriptor
105	 */
106	XSubTotalDescriptor getSubTotalDescriptor();
107
108	//-------------------------------------------------------------------------
109
110	/** returns the database import descriptor stored with this database
111		range.
112
113		@see DatabaseImportDescriptor
114	 */
115	sequence< com::sun::star::beans::PropertyValue > getImportDescriptor();
116
117	//-------------------------------------------------------------------------
118
119	/** executes the stored import, filter, sorting, and subtotals
120		descriptors again.
121	 */
122	void refresh();
123
124};
125
126//=============================================================================
127
128}; }; }; };
129
130#endif
131
132