offapi/com/sun/star/sheet/XSheetCellCursor.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: XSheetCellCursor.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_sheet_XSheetCellCursor_idl__
  32 #define __com_sun_star_sheet_XSheetCellCursor_idl__
  33
  34 #ifndef __com_sun_star_sheet_XSheetCellRange_idl__
  35 #include <com/sun/star/sheet/XSheetCellRange.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** provides advanced methods to control the position of a cursor in a
  45     spreadsheet.
  46
  47     @see com::sun::star::sheet::SheetCellCursor
  48  */
  49 published interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** expands the cursor into the region containing the cells to which
  54         it currently points.
  55
  56         <p>A region is a cell range bounded by empty cells.</p>
  57      */
  58     void collapseToCurrentRegion();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** collapses the cursor into the range of the array formula to which
  63         it is currently pointing.
  64
  65         <p>To get the correct result, the top left cell of the original
  66         cursor must point to any cell containing an array formula.
  67         If not, the cursor is left unchanged.</p>
  68      */
  69     void collapseToCurrentArray();
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** expands the cursor to merged cell ranges.
  74
  75         <p>Expands the current cursor range in a way so that all merged
  76         cell ranges intersecting the current range will fit completely.
  77         If the cursor does not point to any range with merged cells, it
  78         is left unchanged.</p>
  79      */
  80     void collapseToMergedArea();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** expands the cursor to include the entire columns of the cells
  85         to which it is currently pointing.
  86      */
  87     void expandToEntireColumns();
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** expands the cursor to include the entire rows of the cells to
  92         which it is currently pointing.
  93      */
  94     void expandToEntireRows();
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** changes the size of a cursor range.
  99
 100         <p>The top left cell of the cursor keeps unmodified. </p>
 101
 102         @param nColumns
 103             the number of columns of the new cursor range.
 104         @param nRows
 105             the number of rows of the new cursor range.
 106      */
 107     void collapseToSize( [in] long nColumns, [in] long nRows );
 108
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; };
 114
 115 #endif
 116