offapi/com/sun/star/sheet/XCalculatable.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_XCalculatable_idl__
  21 #define __com_sun_star_sheet_XCalculatable_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** represents something that can recalculate.
  30  */
  31 published interface XCalculatable: com::sun::star::uno::XInterface
  32 {
  33
  34     /** recalculates all dirty cells.
  35
  36         <p>This calculates all formula cells which have not yet been
  37         calculated after their precedents have changed.</p>
  38      */
  39     void calculate();
  40
  41
  42     /** recalculates all cells.
  43      */
  44     void calculateAll();
  45
  46
  47     /** returns whether automatic calculation is enabled.
  48
  49         <p>With automatic calculation, each formula cell is recalculated
  50         whenever its value is needed after its precedents have changed.
  51         The value is needed if the cell is displayed or used in another
  52         calculation.</p>
  53
  54         @returns
  55             `TRUE`, if automatic calculation is enabled.
  56      */
  57     boolean isAutomaticCalculationEnabled();
  58
  59
  60     /** enables automatic calculation.
  61
  62         <p>With automatic calculation, each formula cell is recalculated
  63         whenever its value is needed after its precedents have changed.
  64         The value is needed if the cell is displayed or used in another
  65         calculation.</p>
  66
  67         @param bEnabled
  68             `TRUE` to enable automatic calculation, `FALSE` to disable.
  69      */
  70     void enableAutomaticCalculation( [in] boolean bEnabled );
  71
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */