/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XUsedAreaCursor_idl__
#define __com_sun_star_sheet_XUsedAreaCursor_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

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

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

/** provides methods to find the used area of the entire sheet.

    <p>The used area is the smallest cell range that contains all cells
    of the spreadsheet with any contents (values, text, formulas) or
    visible formatting (borders and background color).</p>

    @see com::sun::star::sheet::SheetCellCursor
 */
published interface XUsedAreaCursor: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** points the cursor to the start of the used area.

        @param bExpand
            <TRUE/> = expands the current cursor range,
            <FALSE/> = sets size of the cursor to a single cell.
     */
    void gotoStartOfUsedArea( [in] boolean bExpand );

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

    /** points the cursor to the end of the used area.

        @param bExpand
            <TRUE/> = expands the current cursor range,
            <FALSE/> = sets size of the cursor to a single cell.
     */
    void gotoEndOfUsedArea( [in] boolean bExpand );

};

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

}; }; }; };

#endif

