offapi/com/sun/star/sheet/XUsedAreaCursor.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: XUsedAreaCursor.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_XUsedAreaCursor_idl__
  32 #define __com_sun_star_sheet_XUsedAreaCursor_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** provides methods to find the used area of the entire sheet.
  45
  46     <p>The used area is the smallest cell range that contains all cells
  47     of the spreadsheet with any contents (values, text, formulas) or
  48     visible formatting (borders and background color).</p>
  49
  50     @see com::sun::star::sheet::SheetCellCursor
  51  */
  52 published interface XUsedAreaCursor: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** points the cursor to the start of the used area.
  57
  58         @param bExpand
  59             <TRUE/> = expands the current cursor range,
  60             <FALSE/> = sets size of the cursor to a single cell.
  61      */
  62     void gotoStartOfUsedArea( [in] boolean bExpand );
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** points the cursor to the end of the used area.
  67
  68         @param bExpand
  69             <TRUE/> = expands the current cursor range,
  70             <FALSE/> = sets size of the cursor to a single cell.
  71      */
  72     void gotoEndOfUsedArea( [in] boolean bExpand );
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif
  81