offapi/com/sun/star/sheet/XSheetOperation.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_XSheetOperation_idl__
  29 #define __com_sun_star_sheet_XSheetOperation_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  36 #include <com/sun/star/sheet/GeneralFunction.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_uno_Exception_idl__
  40 #include <com/sun/star/uno/Exception.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module sheet {
  46
  47 //=============================================================================
  48
  49 /** provides methods to execute operations on a cell range or ranges.
  50
  51     @see com::sun::star::sheet::SheetCellRange
  52     @see com::sun::star::sheet::SheetCellRanges
  53  */
  54 published interface XSheetOperation: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** computes a general function based on all cells in the current
  59         cell range(s).
  60
  61         @param nFunction
  62             is the function used to compute the result.
  63
  64         @returns
  65             the result of the calculation.
  66      */
  67     double computeFunction(
  68             [in] com::sun::star::sheet::GeneralFunction nFunction )
  69         raises( com::sun::star::uno::Exception );   //! unnecessary
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** clears the specified contents of the current cell range(s).
  74
  75         @param nContentFlags
  76             a combination of <type>CellFlags</type> flags selecting the
  77             contents to be deleted.
  78      */
  79     void clearContents( [in] long nContentFlags );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif