offapi/com/sun/star/sheet/DataPilotField.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: DataPilotField.idl,v $
  10  * $Revision: 1.10 $
  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_DataPilotField_idl__
  32 #define __com_sun_star_sheet_DataPilotField_idl__
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sheet_XDataPilotField_idl__
  43 #include <com/sun/star/sheet/XDataPilotField.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_sheet_XDataPilotFieldGrouping_idl__
  47 #include <com/sun/star/sheet/XDataPilotFieldGrouping.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__
  51 #include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  55 #include <com/sun/star/sheet/GeneralFunction.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
  59 #include <com/sun/star/sheet/DataPilotFieldReference.idl>
  60 #endif
  61
  62 #ifndef __com_sun_star_sheet_DataPilotFieldLayoutInfo_idl__
  63 #include <com/sun/star/sheet/DataPilotFieldLayoutInfo.idl>
  64 #endif
  65
  66 #ifndef __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__
  67 #include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.idl>
  68 #endif
  69
  70 #ifndef __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
  71 #include <com/sun/star/sheet/DataPilotFieldSortInfo.idl>
  72 #endif
  73
  74 #ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__
  75 #include <com/sun/star/sheet/DataPilotFieldGroupInfo.idl>
  76 #endif
  77
  78 //=============================================================================
  79
  80 module com {  module sun {  module star {  module sheet {
  81
  82 //=============================================================================
  83
  84 /** represents a single field in a data pilot table.
  85
  86     <p>If the data pilot table is based on a spreadsheet cell range, a field
  87     is representred by a column of the range and is named using the topmost
  88     cell of the column.</p>
  89  */
  90 published service DataPilotField
  91 {
  92     //-------------------------------------------------------------------------
  93
  94     /** provides access to the name of the data pilot field.
  95      */
  96     interface com::sun::star::container::XNamed;
  97
  98     //-------------------------------------------------------------------------
  99
 100 //!published service PropertySet
 101     /** provides access to the properties.
 102      */
 103     interface com::sun::star::beans::XPropertySet;
 104
 105     //-------------------------------------------------------------------------
 106
 107     [optional] interface XDataPilotField;
 108
 109     //-------------------------------------------------------------------------
 110
 111     [optional] interface XDataPilotFieldGrouping;
 112
 113     //=========================================================================
 114
 115     /** specifies the orientation of the field.
 116
 117         <p>If the orientation of a field has been changed using this property,
 118         the field will be moved to the last position in the collection of all
 119         fields with the specified orientation.</p>
 120      */
 121     [property] DataPilotFieldOrientation Orientation;
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** specifies the function used to calculate results for this field.
 126
 127         <p>For column and row fields, this is the function for subtotals
 128         (<const>GeneralFunction::NONE</const> means no subtotals).
 129         For data fields, this is the function shown in the data pilot
 130         table.</p>
 131      */
 132     [property] GeneralFunction Function;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** specifies the functions used to calculate subtotals for this field.
 137
 138         <p>This property is supported by column and row fields only.</p>
 139
 140         <p>An empty sequence means no subtotals. The same effect can be
 141         achieved by setting the property <member>Function</member> to the
 142         value <const>GeneralFunction::NONE</const>. If the length of the
 143         sequence is greater then 1, then the sequence MUST NOT contain one of
 144         the values <const>GeneralFunction::NONE</const> or
 145         <const>GeneralFunction::AUTO</const>.</p>
 146
 147         <p>The order of the functions in this sequence is reflected in the
 148         DataPilot table. Multiple entries of the same function are ignored
 149         when setting the property.</p>
 150      */
 151     [property, optional] sequence<GeneralFunction> Subtotals;
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** specifies the selected page which is used to filter the data pilot.
 156      */
 157     [property, optional] string SelectedPage;
 158
 159     //-------------------------------------------------------------------------
 160
 161     /** specifies whether to use the selected page to filter the data pilot or
 162         show all.
 163      */
 164     [property, optional] boolean UseSelectedPage;
 165
 166     //-------------------------------------------------------------------------
 167
 168     /** specifies which hierarchy of the dimension is used.
 169
 170     @see com::sun::star::sheet::DataPilotSourceHierarchies
 171      */
 172     [property, optional] string UsedHierarchy;
 173
 174     //-------------------------------------------------------------------------
 175
 176     /** specifies whether this field has sorting information.
 177      */
 178     [property, optional] boolean HasSortInfo;
 179
 180     //-------------------------------------------------------------------------
 181
 182     /** controls how the field's items are sorted.
 183      */
 184     [property, optional] DataPilotFieldSortInfo SortInfo;
 185
 186     //-------------------------------------------------------------------------
 187
 188     /** specifies whether this field has layout information.
 189      */
 190     [property, optional] boolean HasLayoutInfo;
 191
 192     //-------------------------------------------------------------------------
 193
 194     /** controls how the field's items are laid out in the result table.
 195      */
 196     [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
 197
 198     //-------------------------------------------------------------------------
 199
 200     /** specifies whether this field has auto show information.
 201      */
 202     [property, optional] boolean HasAutoShowInfo;
 203
 204     //-------------------------------------------------------------------------
 205
 206     /** enables the automatic inclusion of only a number of items with
 207         the highest or lowest result values.
 208      */
 209     [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
 210
 211     //-------------------------------------------------------------------------
 212
 213     /** specifies whether this field has a reference.
 214      */
 215     [property, optional] boolean HasReference;
 216
 217     //-------------------------------------------------------------------------
 218
 219     /** controls how the results are shown in relation to a selected
 220         reference result.
 221      */
 222     [property, optional] DataPilotFieldReference Reference;
 223
 224     //-------------------------------------------------------------------------
 225
 226     /** specifies whether this field is a group field.
 227      */
 228     [property, optional] boolean IsGroupField;
 229
 230     //-------------------------------------------------------------------------
 231
 232     /** contains the grouping information of the DataPilot field.
 233
 234         <p>By changing the value of this property it is possible to modify the
 235         grouping settings of this field.</p>
 236      */
 237     [property, optional] DataPilotFieldGroupInfo GroupInfo;
 238
 239     //-------------------------------------------------------------------------
 240
 241     /** specifies whether to show this field also if it is empty or not.
 242      */
 243     [property, optional] boolean ShowEmpty;
 244 };
 245
 246 //=============================================================================
 247
 248 }; }; }; };
 249
 250 #endif
 251