offapi/com/sun/star/sheet/DataPilotSource.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 /** represents a data pilot source.
  25
  26     <p>A component that implements this service can be used as data source
  27     for a data pilot table in a spreadsheet document.</p>
  28  */
  29 service DataPilotSource
  30 {
  31
  32     /** provides access to the collection of the dimensions of the data
  33         pilot source.
  34      */
  35     interface com::sun::star::sheet::XDimensionsSupplier;
  36
  37
  38     /** gives access to the results of the data pilot table.
  39      */
  40     interface com::sun::star::sheet::XDataPilotResults;
  41
  42
  43     /** provides methods to refresh the data pilot table, that means to
  44         read the data again from the data pilot source.
  45      */
  46     interface com::sun::star::util::XRefreshable;
  47
  48
  49 //!published service PropertySet
  50     /** provides access to the properties.
  51      */
  52     interface com::sun::star::beans::XPropertySet;
  53
  54
  55     /** specifies if grand totals for the columns are inserted.
  56      */
  57     [property] boolean ColumnGrand;
  58
  59
  60     /** specifies if grand totals for the rows are inserted.
  61      */
  62     [property] boolean RowGrand;
  63
  64
  65     /** specifies the number of row fields.
  66
  67         @since OOo 3.0
  68      */
  69     [readonly, property, optional] long RowFieldCount;
  70
  71
  72     /** specifies the number of column fields.
  73
  74         @since OOo 3.0
  75      */
  76     [readonly, property, optional] long ColumnFieldCount;
  77
  78
  79     /** specifies the number of data fields.
  80
  81         @since OOo 3.0
  82      */
  83     [readonly, property, optional] long DataFieldCount;
  84 };
  85
  86
  87 }; }; }; };
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */