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_DataPilotFieldGroupInfo_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sheet_XDataPilotField_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/sheet/XDataPilotField.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XNameAccess_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XNameAccess.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sheet { 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski/** contains the grouping information of a <type>DataPilotField</type>. 41*b1cdbd2cSJim Jagielski */ 42*b1cdbd2cSJim Jagielskipublished struct DataPilotFieldGroupInfo 43*b1cdbd2cSJim Jagielski{ 44*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski /** specifies whether the start value for the grouping is taken 47*b1cdbd2cSJim Jagielski automatically from the minimum of the item values. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski <p><ul> 50*b1cdbd2cSJim Jagielski <li>If <FALSE/> is set, the value from <member>Start</member> will be 51*b1cdbd2cSJim Jagielski used as start value for the grouping.</li> 52*b1cdbd2cSJim Jagielski <li>If <TRUE/> is set, the start value for the grouping will be 53*b1cdbd2cSJim Jagielski calculated automatically from the minimum of all member values of the 54*b1cdbd2cSJim Jagielski DataPilot field.</li> 55*b1cdbd2cSJim Jagielski </ul></p> 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski boolean HasAutoStart; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** specifies whether the end value for the grouping is taken 62*b1cdbd2cSJim Jagielski automatically from the maximum of the item values. 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p><ul> 65*b1cdbd2cSJim Jagielski <li>If <FALSE/> is set, the value from <member>End</member> will be 66*b1cdbd2cSJim Jagielski used as end value for the grouping.</li> 67*b1cdbd2cSJim Jagielski <li>If <TRUE/> is set, the end value for the grouping will be 68*b1cdbd2cSJim Jagielski calculated automatically from the maximum of all member values of the 69*b1cdbd2cSJim Jagielski DataPilot field.</li> 70*b1cdbd2cSJim Jagielski </ul></p> 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski boolean HasAutoEnd; 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** specifies whether date values are grouped by ranges of days. 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski <p><ul> 79*b1cdbd2cSJim Jagielski <li>If <FALSE/> is set, and <member>GroupBy</member> contains zero, 80*b1cdbd2cSJim Jagielski grouping is performed inplace on the item values.</li> 81*b1cdbd2cSJim Jagielski <li>If <FALSE/> is set, and <member>GroupBy</member> contains one or 82*b1cdbd2cSJim Jagielski more flags from <type>DataPilotFieldGroupBy</type>, grouping is 83*b1cdbd2cSJim Jagielski performed on date or time.</li> 84*b1cdbd2cSJim Jagielski <li>If <TRUE/> is set, <member>Step</member> contains a value greater 85*b1cdbd2cSJim Jagielski than or equal to 1, and <member>GroupBy</member> set to <const> 86*b1cdbd2cSJim Jagielski DataPilotFieldGroupBy::DAYS</const>, grouping is performed on ranges 87*b1cdbd2cSJim Jagielski of days (see descriptions for <member> 88*b1cdbd2cSJim Jagielski XDataPilotFieldGrouping::createDateGroup</member> for more details 89*b1cdbd2cSJim Jagielski about day grouping).</li> 90*b1cdbd2cSJim Jagielski </ul></p> 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski boolean HasDateValues; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski /** specifies the start value for the grouping if <member>HasAutoStart 97*b1cdbd2cSJim Jagielski </member> is set to <FALSE/>. 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski double Start; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski /** specifies the end value for the grouping if <member>HasAutoEnd 104*b1cdbd2cSJim Jagielski </member> is set to <FALSE/>. 105*b1cdbd2cSJim Jagielski */ 106*b1cdbd2cSJim Jagielski double End; 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski /** specifies the size of the ranges for numeric or day grouping. 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski <p>Example: With <member>HasAutoStart</member> set to <FALSE/>, 113*b1cdbd2cSJim Jagielski <member>Start</member> set to 2, and <member>Step</member> set to 3, 114*b1cdbd2cSJim Jagielski the first group will contain all values greater than or equal to 2 and 115*b1cdbd2cSJim Jagielski less than 5. The second group will contain all values greater than or 116*b1cdbd2cSJim Jagielski equal to 5 and less then 8, and so on.</p> 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski double Step; 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski /** specifies the grouping of the date values. 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski @see DataPilotFieldGroupBy 125*b1cdbd2cSJim Jagielski */ 126*b1cdbd2cSJim Jagielski long GroupBy; 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski /** contains the source DataPilot field grouping is based on. Will be 131*b1cdbd2cSJim Jagielski <NULL/> if this field is not grouped or contains numeric grouping. 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski @see DataPilotField 134*b1cdbd2cSJim Jagielski */ 135*b1cdbd2cSJim Jagielski XDataPilotField SourceField; 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski /** specifies the named groups in this field if there are some. 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski <p>The returned object is an instance of <type>DataPilotFieldGroups 142*b1cdbd2cSJim Jagielski </type>. The collection of groups can be modified by inserting, 143*b1cdbd2cSJim Jagielski removing, replacing, or renaming single groups or item names in the 144*b1cdbd2cSJim Jagielski groups. When writing back this struct containing such a changed 145*b1cdbd2cSJim Jagielski collection of groups to the <member>DataPilotField::GroupInfo</member> 146*b1cdbd2cSJim Jagielski property, the modified grouping settings are applied at the DataPilot 147*b1cdbd2cSJim Jagielski field.</p> 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski @see DataPilotField 150*b1cdbd2cSJim Jagielski @see DataPilotFieldGroups 151*b1cdbd2cSJim Jagielski */ 152*b1cdbd2cSJim Jagielski com::sun::star::container::XNameAccess Groups; 153*b1cdbd2cSJim Jagielski}; 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski//============================================================================= 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski}; }; }; }; 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski#endif 160*b1cdbd2cSJim Jagielski 161