offapi/com/sun/star/table/XCellCursor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCellCursor.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_table_XCellCursor_idl__
  32 #define __com_sun_star_table_XCellCursor_idl__
  33
  34 #ifndef __com_sun_star_table_XCellRange_idl__
  35 #include <com/sun/star/table/XCellRange.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module table {
  41
  42 //=============================================================================
  43
  44 /** provides methods to control the position of a cell cursor.
  45
  46     @see com::sun::star::table::CellCursor
  47  */
  48 published interface XCellCursor: com::sun::star::table::XCellRange
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** points the cursor to a single cell which is the beginning of a
  53         contiguous series of (filled) cells.
  54      */
  55     void gotoStart();
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** points the cursor to a single cell which is the end of a contiguous
  60         series of (filled) cells.
  61      */
  62     void gotoEnd();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** points the cursor to the next unprotected cell.
  67
  68         <p>If the sheet is not protected, this is the next cell to the
  69         right.</p>
  70      */
  71     void gotoNext();
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** points the cursor to the previous unprotected cell.
  76
  77         <p>If the sheet is not protected, this is the next cell to the
  78         left.</p>
  79      */
  80     void gotoPrevious();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** moves the origin of the cursor relative to the current position.
  85
  86         @param nColumnOffset
  87             is the count of columns to move. A negative value moves the
  88             cursor to the left.
  89
  90         @param nRowOffset
  91             is the count of rows to move. A negative value moves the
  92             cursor to the top.
  93      */
  94     void gotoOffset( [in] long nColumnOffset, [in] long nRowOffset );
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif
 103