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