offapi/com/sun/star/sheet/DataPilotSource.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DataPilotSource.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_DataPilotSource_idl__
  32 #define __com_sun_star_sheet_DataPilotSource_idl__
  33
  34 #ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__
  35 #include <com/sun/star/sheet/XDimensionsSupplier.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XDataPilotResults_idl__
  39 #include <com/sun/star/sheet/XDataPilotResults.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_util_XRefreshable_idl__
  43 #include <com/sun/star/util/XRefreshable.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** represents a data pilot source.
  57
  58     <p>A component that implements this service can be used as data source
  59     for a data pilot table in a spreadsheet document.</p>
  60  */
  61 published service DataPilotSource
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** provides access to the collection of the dimensions of the data
  66         pilot source.
  67      */
  68     interface com::sun::star::sheet::XDimensionsSupplier;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** gives access to the results of the data pilot table.
  73      */
  74     interface com::sun::star::sheet::XDataPilotResults;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** provides methods to refresh the data pilot table, that means to
  79         read the data again from the data pilot source.
  80      */
  81     interface com::sun::star::util::XRefreshable;
  82
  83     //-------------------------------------------------------------------------
  84
  85 //!published service PropertySet
  86     /** provides access to the properties.
  87      */
  88     interface com::sun::star::beans::XPropertySet;
  89
  90     //=========================================================================
  91
  92     /** specifies if grand totals for the columns are inserted.
  93      */
  94     [property] boolean ColumnGrand;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** specifies if grand totals for the rows are inserted.
  99      */
 100     [property] boolean RowGrand;
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** specifies the number of row fields.
 105
 106         @since OOo 3.0.0
 107      */
 108     [readonly, property, optional] long RowFieldCount;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** specifies the number of column fields.
 113
 114         @since OOo 3.0.0
 115      */
 116     [readonly, property, optional] long ColumnFieldCount;
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** specifies the number of data fields.
 121
 122         @since OOo 3.0.0
 123      */
 124     [readonly, property, optional] long DataFieldCount;
 125 };
 126
 127 //=============================================================================
 128
 129 }; }; }; };
 130
 131 #endif
 132