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