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