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