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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_DataPilotTableDescriptor_idl__
  29 #define __com_sun_star_sheet_DataPilotTableDescriptor_idl__
  30
  31 #ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
  32 #include <com/sun/star/sheet/XDataPilotDescriptor.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
  36 #include <com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_beans_XPropertySet_idl__
  40 #include <com/sun/star/beans/XPropertySet.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_beans_PropertyValue_idl__
  44 #include <com/sun/star/beans/PropertyValue.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com { module sun { module star { module sheet {
  50
  51 //=============================================================================
  52
  53 /** represents the description of the layout of a data pilot table.
  54
  55     @see com::sun::star::sheet::DataPilotTable
  56 */
  57 published service DataPilotDescriptor
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** provides access to the layout settings of the data pilot table.
  62      */
  63     interface XDataPilotDescriptor;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** provides access to the layout settings of the data pilot table.
  68      */
  69     [optional] interface com::sun::star::beans::XPropertySet;
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** Provides access to the <type>DataPilotField</type> used to layout
  74         multiple data fields.
  75      */
  76     [optional] interface XDataPilotDataLayoutFieldSupplier;
  77
  78     //=========================================================================
  79
  80     /** specifies parameters to create the data pilot table from a database.
  81
  82     @see DatabaseImportDescriptor
  83     @since OOo 3.3.0
  84
  85      */
  86     [optional, property] sequence< com::sun::star::beans::PropertyValue > ImportDescriptor;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** specifies the name of a <type>DataPilotSource</type> implementation
  91         for the data pilot table.
  92
  93     @since OOo 3.3.0
  94
  95      */
  96     [optional, property] string SourceServiceName;
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** specifies arguments that are passed to the implementation named by
 101         <member>SourceServiceName</member>.
 102
 103     @since OOo 3.3.0
 104
 105      */
 106     [optional, property] sequence< com::sun::star::beans::PropertyValue > ServiceArguments;
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** specifies the orientation of the field.
 111      */
 112     [optional, property] boolean IgnoreEmptyRows;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies the orientation of the field.
 117      */
 118     [optional, property] boolean RepeatIfEmpty;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** specifies the orientation of the field.
 123      */
 124     [optional, property] boolean ColumnGrand;
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** specifies the orientation of the field.
 129      */
 130     [optional, property] boolean RowGrand;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** specifies whether the filter button is shown.
 135      */
 136     [optional, property] boolean ShowFilterButton;
 137
 138     //-------------------------------------------------------------------------
 139
 140     /** specifies whether to drill down to details or go into edit mode.
 141      */
 142     [optional, property] boolean DrillDownOnDoubleClick;
 143
 144     //-------------------------------------------------------------------------
 145 };
 146
 147 //=============================================================================
 148
 149 }; }; }; };
 150
 151 #endif