offapi/com/sun/star/sheet/XSubTotalField.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_XSubTotalField_idl__
  21 #define __com_sun_star_sheet_XSubTotalField_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/SubTotalColumn.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides access to the settings of a field in a subtotal descriptor.
  31
  32     @see com::sun::star::sheet::SubTotalField
  33     @see com::sun::star::sheet::SubTotalDescriptor
  34  */
  35 published interface XSubTotalField: com::sun::star::uno::XInterface
  36 {
  37
  38     /** returns the column by which entries are grouped.
  39      */
  40     long getGroupColumn();
  41
  42
  43     /** sets the column by which entries are grouped.
  44      */
  45     void setGroupColumn( [in] long nGroupColumn );
  46
  47
  48     /** returns the definitions of which columns should have subtotals
  49         added to them.
  50      */
  51     sequence< com::sun::star::sheet::SubTotalColumn > getSubTotalColumns();
  52
  53
  54     /** sets the definitions of which columns should have subtotals
  55         added to them.
  56      */
  57     void setSubTotalColumns(
  58         [in] sequence< com::sun::star::sheet::SubTotalColumn >
  59             aSubTotalColumns );
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */