offapi/com/sun/star/sheet/XSpreadsheet.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: XSpreadsheet.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_XSpreadsheet_idl__
  32 #define __com_sun_star_sheet_XSpreadsheet_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  published interface XSheetCellCursor;
  45
  46 //=============================================================================
  47
  48 /** provides methods to create a cell range cursor.
  49  */
  50 published interface XSpreadsheet: com::sun::star::sheet::XSheetCellRange
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** creates a cell cursor including the whole spreadsheet.
  55
  56         @see com::sun::star::sheet::SheetCellCursor
  57      */
  58     com::sun::star::sheet::XSheetCellCursor createCursor();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** creates a cell cursor to travel in the given range context.
  63
  64         @param aRange
  65             the cell range for the cursor.
  66
  67         @see com::sun::star::sheet::SheetCellCursor
  68      */
  69     com::sun::star::sheet::XSheetCellCursor createCursorByRange(
  70             [in] com::sun::star::sheet::XSheetCellRange aRange );
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif
  79