/*************************************************************************
 *
 *  $RCSfile: XSheetCellCursor.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:08:25 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XSheetCellCursor_idl__
#define __com_sun_star_sheet_XSheetCellCursor_idl__

#ifndef __com_sun_star_sheet_XSheetCellRange_idl__
#include <com/sun/star/sheet/XSheetCellRange.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides advanced methods to control the position of a cursor in a
	spreadsheet.

	@see com::sun::star::sheet::SheetCellCursor
 */
interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange
{
	//-------------------------------------------------------------------------

	/** expands the cursor into the region containing the cells to which
		it currently points.

		<p>A region is a cell range bounded by empty cells.</p>
	 */
	void collapseToCurrentRegion();

	//-------------------------------------------------------------------------

	/** collapses the cursor into the range of the array formula to which
		it is currently pointing.

		<p>To get the correct result, the top left cell of the original
		cursor must point to any cell containing an array formula.
		If not, the cursor is left unchanged.</p>
	 */
	void collapseToCurrentArray();

	//-------------------------------------------------------------------------

	/** expands the cursor to merged cell ranges.

		<p>Expands the current cursor range in a way so that all merged
		cell ranges intersecting the current range will fit completely.
		If the cursor does not point to any range with merged cells, it
		is left unchanged.</p>
	 */
	void collapseToMergedArea();

	//-------------------------------------------------------------------------

	/** expands the cursor to include the entire columns of the cells
		to which it is currently pointing.
	 */
	void expandToEntireColumns();

	//-------------------------------------------------------------------------

	/** expands the cursor to include the entire rows of the cells to
		which it is currently pointing.
	 */
	void expandToEntireRows();

	//-------------------------------------------------------------------------

	/** changes the size of a cursor range.

		<p>The top left cell of the cursor keeps unmodified. </p>

		@param nColumns
			the number of columns of the new cursor range.
		@param nRows
			the number of rows of the new cursor range.
	 */
	void collapseToSize( [in] long nColumns, [in] long nRows );

};

//=============================================================================

}; }; }; };

#endif

