offapi/com/sun/star/sheet/XCalculatable.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: XCalculatable.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_XCalculatable_idl__
  32 #define __com_sun_star_sheet_XCalculatable_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** represents something that can recalculate.
  45  */
  46 published interface XCalculatable: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** recalculates all dirty cells.
  51
  52         <p>This calculates all formula cells which have not yet been
  53         calculated after their precedents have changed.</p>
  54      */
  55     void calculate();
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** recalculates all cells.
  60      */
  61     void calculateAll();
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** returns whether automatic calculation is enabled.
  66
  67         <p>With automatic calculation, each formula cell is recalculated
  68         whenever its value is needed after its precedents have changed.
  69         The value is needed if the cell is displayed or used in another
  70         calculation.</p>
  71
  72         @returns
  73             <TRUE/>, if automatic calculation is enabled.
  74      */
  75     boolean isAutomaticCalculationEnabled();
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** enables automatic calculation.
  80
  81         <p>With automatic calculation, each formula cell is recalculated
  82         whenever its value is needed after its precedents have changed.
  83         The value is needed if the cell is displayed or used in another
  84         calculation.</p>
  85
  86         @param bEnabled
  87             <TRUE/> to enable automatic calculation, <FALSE/> to disable.
  88      */
  89     [oneway] void enableAutomaticCalculation( [in] boolean bEnabled );
  90
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif
  98