offapi/com/sun/star/sheet/XSubTotalCalculatable.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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** contains methods to handle a subtotal descriptor.
  25
  26     <p>The subtotal descriptor provides properties to set up the subtotal
  27     function.</p>
  28
  29     @see com::sun::star::sheet::SheetCellRange
  30     @see com::sun::star::sheet::SubTotalDescriptor
  31  */
  32 published interface XSubTotalCalculatable: com::sun::star::uno::XInterface
  33 {
  34
  35     /** creates a subtotal descriptor.
  36
  37         @param bEmpty
  38             if set to `TRUE`, creates an empty descriptor. If set to
  39             `FALSE`, fills the descriptor with previous settings of the
  40             current object (i.e. a database range).
  41      */
  42     com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor(
  43             [in] boolean bEmpty );
  44
  45
  46     /** creates subtotals using the settings of the passed descriptor.
  47
  48         @param xDescriptor
  49             the subtotal descriptor with the settings used for the subtotal
  50             operation.
  51
  52         @param bReplace
  53             if set to `TRUE`, replaces previous subtotal results.
  54      */
  55     void applySubTotals(
  56             [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,
  57             [in] boolean bReplace );
  58
  59
  60     /** removes the subtotals from the current object.
  61      */
  62     void removeSubTotals();
  63
  64 };
  65
  66
  67 }; }; }; };
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */