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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XSheetOperation_idl__
  21 #define __com_sun_star_sheet_XSheetOperation_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/GeneralFunction.idl>
  25 #include <com/sun/star/uno/Exception.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** provides methods to execute operations on a cell range or ranges.
  32
  33     @see com::sun::star::sheet::SheetCellRange
  34     @see com::sun::star::sheet::SheetCellRanges
  35  */
  36 published interface XSheetOperation: com::sun::star::uno::XInterface
  37 {
  38
  39     /** computes a general function based on all cells in the current
  40         cell range(s).
  41
  42         @param nFunction
  43             is the function used to compute the result.
  44
  45         @returns
  46             the result of the calculation.
  47      */
  48     double computeFunction(
  49             [in] com::sun::star::sheet::GeneralFunction nFunction )
  50         raises( com::sun::star::uno::Exception );   //! unnecessary
  51
  52
  53     /** clears the specified contents of the current cell range(s).
  54
  55         @param nContentFlags
  56             a combination of CellFlags flags selecting the
  57             contents to be deleted.
  58      */
  59     void clearContents( [in] long nContentFlags );
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */