offapi/com/sun/star/sheet/XSpreadsheet.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XSpreadsheet_idl__
  29 #define __com_sun_star_sheet_XSpreadsheet_idl__
  30
  31 #ifndef __com_sun_star_sheet_XSheetCellRange_idl__
  32 #include <com/sun/star/sheet/XSheetCellRange.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module sheet {
  38
  39 //=============================================================================
  40
  41  published interface XSheetCellCursor;
  42
  43 //=============================================================================
  44
  45 /** provides methods to create a cell range cursor.
  46  */
  47 published interface XSpreadsheet: com::sun::star::sheet::XSheetCellRange
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** creates a cell cursor including the whole spreadsheet.
  52
  53         @see com::sun::star::sheet::SheetCellCursor
  54      */
  55     com::sun::star::sheet::XSheetCellCursor createCursor();
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** creates a cell cursor to travel in the given range context.
  60
  61         @param aRange
  62             the cell range for the cursor.
  63
  64         @see com::sun::star::sheet::SheetCellCursor
  65      */
  66     com::sun::star::sheet::XSheetCellCursor createCursorByRange(
  67             [in] com::sun::star::sheet::XSheetCellRange aRange );
  68
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif
  76