/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XCellCursor.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:51:22 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#ifndef __com_sun_star_table_XCellCursor_idl__
#define __com_sun_star_table_XCellCursor_idl__

#ifndef __com_sun_star_table_XCellRange_idl__
#include <com/sun/star/table/XCellRange.idl>
#endif

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

module com {  module sun {  module star {  module table {

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

/** provides methods to control the position of a cell cursor.

    @see com::sun::star::table::CellCursor
 */
published interface XCellCursor: com::sun::star::table::XCellRange
{
    //-------------------------------------------------------------------------

    /** points the cursor to a single cell which is the beginning of a
        contiguous series of (filled) cells.
     */
    void gotoStart();

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

    /** points the cursor to a single cell which is the end of a contiguous
        series of (filled) cells.
     */
    void gotoEnd();

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

    /** points the cursor to the next unprotected cell.

        <p>If the sheet is not protected, this is the next cell to the
        right.</p>
     */
    void gotoNext();

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

    /** points the cursor to the previous unprotected cell.

        <p>If the sheet is not protected, this is the next cell to the
        left.</p>
     */
    void gotoPrevious();

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

    /** moves the origin of the cursor relative to the current position.

        @param nColumnOffset
            is the count of columns to move. A negative value moves the
            cursor to the left.

        @param nRowOffset
            is the count of rows to move. A negative value moves the
            cursor to the top.
     */
    void gotoOffset( [in] long nColumnOffset, [in] long nRowOffset );

};

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

}; }; }; };

#endif

