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_XUsedAreaCursor_idl__
25#define __com_sun_star_sheet_XUsedAreaCursor_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** provides methods to find the used area of the entire sheet.
38
39	<p>The used area is the smallest cell range that contains all cells
40	of the spreadsheet with any contents (values, text, formulas) or
41	visible formatting (borders and background color).</p>
42
43	@see com::sun::star::sheet::SheetCellCursor
44 */
45published interface XUsedAreaCursor: com::sun::star::uno::XInterface
46{
47	//-------------------------------------------------------------------------
48
49	/** points the cursor to the start of the used area.
50
51		@param bExpand
52			<TRUE/> = expands the current cursor range,
53			<FALSE/> = sets size of the cursor to a single cell.
54	 */
55	void gotoStartOfUsedArea( [in] boolean bExpand );
56
57	//-------------------------------------------------------------------------
58
59	/** points the cursor to the end of the used area.
60
61		@param bExpand
62			<TRUE/> = expands the current cursor range,
63			<FALSE/> = sets size of the cursor to a single cell.
64	 */
65	void gotoEndOfUsedArea( [in] boolean bExpand );
66
67};
68
69//=============================================================================
70
71}; }; }; };
72
73#endif
74
75