1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotField_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sheet_DataPilotField_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XNamed_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XNamed.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertySet_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertySet.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_XDataPilotField_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/XDataPilotField.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_XDataPilotFieldGrouping_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/XDataPilotFieldGrouping.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ 44*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/DataPilotFieldOrientation.idl> 45*b1cdbd2cSJim Jagielski#endif 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_GeneralFunction_idl__ 48*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/GeneralFunction.idl> 49*b1cdbd2cSJim Jagielski#endif 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__ 52*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/DataPilotFieldReference.idl> 53*b1cdbd2cSJim Jagielski#endif 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotFieldLayoutInfo_idl__ 56*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/DataPilotFieldLayoutInfo.idl> 57*b1cdbd2cSJim Jagielski#endif 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__ 60*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.idl> 61*b1cdbd2cSJim Jagielski#endif 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotFieldSortInfo_idl__ 64*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/DataPilotFieldSortInfo.idl> 65*b1cdbd2cSJim Jagielski#endif 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__ 68*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/DataPilotFieldGroupInfo.idl> 69*b1cdbd2cSJim Jagielski#endif 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski//============================================================================= 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sheet { 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski//============================================================================= 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski/** represents a single field in a data pilot table. 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski <p>If the data pilot table is based on a spreadsheet cell range, a field 80*b1cdbd2cSJim Jagielski is representred by a column of the range and is named using the topmost 81*b1cdbd2cSJim Jagielski cell of the column.</p> 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielskipublished service DataPilotField 84*b1cdbd2cSJim Jagielski{ 85*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski /** provides access to the name of the data pilot field. 88*b1cdbd2cSJim Jagielski */ 89*b1cdbd2cSJim Jagielski interface com::sun::star::container::XNamed; 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski//!published service PropertySet 94*b1cdbd2cSJim Jagielski /** provides access to the properties. 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertySet; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski [optional] interface XDataPilotField; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski [optional] interface XDataPilotFieldGrouping; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski //========================================================================= 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski /** specifies the orientation of the field. 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski <p>If the orientation of a field has been changed using this property, 111*b1cdbd2cSJim Jagielski the field will be moved to the last position in the collection of all 112*b1cdbd2cSJim Jagielski fields with the specified orientation.</p> 113*b1cdbd2cSJim Jagielski */ 114*b1cdbd2cSJim Jagielski [property] DataPilotFieldOrientation Orientation; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski /** specifies the function used to calculate results for this field. 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski <p>For column and row fields, this is the function for subtotals 121*b1cdbd2cSJim Jagielski (<const>GeneralFunction::NONE</const> means no subtotals). 122*b1cdbd2cSJim Jagielski For data fields, this is the function shown in the data pilot 123*b1cdbd2cSJim Jagielski table.</p> 124*b1cdbd2cSJim Jagielski */ 125*b1cdbd2cSJim Jagielski [property] GeneralFunction Function; 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski /** specifies the functions used to calculate subtotals for this field. 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski <p>This property is supported by column and row fields only.</p> 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski <p>An empty sequence means no subtotals. The same effect can be 134*b1cdbd2cSJim Jagielski achieved by setting the property <member>Function</member> to the 135*b1cdbd2cSJim Jagielski value <const>GeneralFunction::NONE</const>. If the length of the 136*b1cdbd2cSJim Jagielski sequence is greater then 1, then the sequence MUST NOT contain one of 137*b1cdbd2cSJim Jagielski the values <const>GeneralFunction::NONE</const> or 138*b1cdbd2cSJim Jagielski <const>GeneralFunction::AUTO</const>.</p> 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski <p>The order of the functions in this sequence is reflected in the 141*b1cdbd2cSJim Jagielski DataPilot table. Multiple entries of the same function are ignored 142*b1cdbd2cSJim Jagielski when setting the property.</p> 143*b1cdbd2cSJim Jagielski */ 144*b1cdbd2cSJim Jagielski [property, optional] sequence<GeneralFunction> Subtotals; 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski /** specifies the selected page which is used to filter the data pilot. 149*b1cdbd2cSJim Jagielski */ 150*b1cdbd2cSJim Jagielski [property, optional] string SelectedPage; 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski /** specifies whether to use the selected page to filter the data pilot or 155*b1cdbd2cSJim Jagielski show all. 156*b1cdbd2cSJim Jagielski */ 157*b1cdbd2cSJim Jagielski [property, optional] boolean UseSelectedPage; 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 160*b1cdbd2cSJim Jagielski 161*b1cdbd2cSJim Jagielski /** specifies which hierarchy of the dimension is used. 162*b1cdbd2cSJim Jagielski 163*b1cdbd2cSJim Jagielski @see com::sun::star::sheet::DataPilotSourceHierarchies 164*b1cdbd2cSJim Jagielski */ 165*b1cdbd2cSJim Jagielski [property, optional] string UsedHierarchy; 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 168*b1cdbd2cSJim Jagielski 169*b1cdbd2cSJim Jagielski /** specifies whether this field has sorting information. 170*b1cdbd2cSJim Jagielski */ 171*b1cdbd2cSJim Jagielski [property, optional] boolean HasSortInfo; 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski /** controls how the field's items are sorted. 176*b1cdbd2cSJim Jagielski */ 177*b1cdbd2cSJim Jagielski [property, optional] DataPilotFieldSortInfo SortInfo; 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 180*b1cdbd2cSJim Jagielski 181*b1cdbd2cSJim Jagielski /** specifies whether this field has layout information. 182*b1cdbd2cSJim Jagielski */ 183*b1cdbd2cSJim Jagielski [property, optional] boolean HasLayoutInfo; 184*b1cdbd2cSJim Jagielski 185*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 186*b1cdbd2cSJim Jagielski 187*b1cdbd2cSJim Jagielski /** controls how the field's items are laid out in the result table. 188*b1cdbd2cSJim Jagielski */ 189*b1cdbd2cSJim Jagielski [property, optional] DataPilotFieldLayoutInfo LayoutInfo; 190*b1cdbd2cSJim Jagielski 191*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 192*b1cdbd2cSJim Jagielski 193*b1cdbd2cSJim Jagielski /** specifies whether this field has auto show information. 194*b1cdbd2cSJim Jagielski */ 195*b1cdbd2cSJim Jagielski [property, optional] boolean HasAutoShowInfo; 196*b1cdbd2cSJim Jagielski 197*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski /** enables the automatic inclusion of only a number of items with 200*b1cdbd2cSJim Jagielski the highest or lowest result values. 201*b1cdbd2cSJim Jagielski */ 202*b1cdbd2cSJim Jagielski [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo; 203*b1cdbd2cSJim Jagielski 204*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 205*b1cdbd2cSJim Jagielski 206*b1cdbd2cSJim Jagielski /** specifies whether this field has a reference. 207*b1cdbd2cSJim Jagielski */ 208*b1cdbd2cSJim Jagielski [property, optional] boolean HasReference; 209*b1cdbd2cSJim Jagielski 210*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 211*b1cdbd2cSJim Jagielski 212*b1cdbd2cSJim Jagielski /** controls how the results are shown in relation to a selected 213*b1cdbd2cSJim Jagielski reference result. 214*b1cdbd2cSJim Jagielski */ 215*b1cdbd2cSJim Jagielski [property, optional] DataPilotFieldReference Reference; 216*b1cdbd2cSJim Jagielski 217*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 218*b1cdbd2cSJim Jagielski 219*b1cdbd2cSJim Jagielski /** specifies whether this field is a group field. 220*b1cdbd2cSJim Jagielski */ 221*b1cdbd2cSJim Jagielski [property, optional] boolean IsGroupField; 222*b1cdbd2cSJim Jagielski 223*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski /** contains the grouping information of the DataPilot field. 226*b1cdbd2cSJim Jagielski 227*b1cdbd2cSJim Jagielski <p>By changing the value of this property it is possible to modify the 228*b1cdbd2cSJim Jagielski grouping settings of this field.</p> 229*b1cdbd2cSJim Jagielski */ 230*b1cdbd2cSJim Jagielski [property, optional] DataPilotFieldGroupInfo GroupInfo; 231*b1cdbd2cSJim Jagielski 232*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 233*b1cdbd2cSJim Jagielski 234*b1cdbd2cSJim Jagielski /** specifies whether to show this field also if it is empty or not. 235*b1cdbd2cSJim Jagielski */ 236*b1cdbd2cSJim Jagielski [property, optional] boolean ShowEmpty; 237*b1cdbd2cSJim Jagielski}; 238*b1cdbd2cSJim Jagielski 239*b1cdbd2cSJim Jagielski//============================================================================= 240*b1cdbd2cSJim Jagielski 241*b1cdbd2cSJim Jagielski}; }; }; }; 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski#endif 244*b1cdbd2cSJim Jagielski 245