1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XDataPilotField_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/sheet/XDataPilotField.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir//============================================================================= 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir/** contains the grouping information of a <type>DataPilotField</type>. 45*cdf0e10cSrcweir */ 46*cdf0e10cSrcweirpublished struct DataPilotFieldGroupInfo 47*cdf0e10cSrcweir{ 48*cdf0e10cSrcweir //------------------------------------------------------------------------- 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir /** specifies whether the start value for the grouping is taken 51*cdf0e10cSrcweir automatically from the minimum of the item values. 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir <p><ul> 54*cdf0e10cSrcweir <li>If <FALSE/> is set, the value from <member>Start</member> will be 55*cdf0e10cSrcweir used as start value for the grouping.</li> 56*cdf0e10cSrcweir <li>If <TRUE/> is set, the start value for the grouping will be 57*cdf0e10cSrcweir calculated automatically from the minimum of all member values of the 58*cdf0e10cSrcweir DataPilot field.</li> 59*cdf0e10cSrcweir </ul></p> 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir boolean HasAutoStart; 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir //------------------------------------------------------------------------- 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** specifies whether the end value for the grouping is taken 66*cdf0e10cSrcweir automatically from the maximum of the item values. 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir <p><ul> 69*cdf0e10cSrcweir <li>If <FALSE/> is set, the value from <member>End</member> will be 70*cdf0e10cSrcweir used as end value for the grouping.</li> 71*cdf0e10cSrcweir <li>If <TRUE/> is set, the end value for the grouping will be 72*cdf0e10cSrcweir calculated automatically from the maximum of all member values of the 73*cdf0e10cSrcweir DataPilot field.</li> 74*cdf0e10cSrcweir </ul></p> 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir boolean HasAutoEnd; 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir //------------------------------------------------------------------------- 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir /** specifies whether date values are grouped by ranges of days. 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir <p><ul> 83*cdf0e10cSrcweir <li>If <FALSE/> is set, and <member>GroupBy</member> contains zero, 84*cdf0e10cSrcweir grouping is performed inplace on the item values.</li> 85*cdf0e10cSrcweir <li>If <FALSE/> is set, and <member>GroupBy</member> contains one or 86*cdf0e10cSrcweir more flags from <type>DataPilotFieldGroupBy</type>, grouping is 87*cdf0e10cSrcweir performed on date or time.</li> 88*cdf0e10cSrcweir <li>If <TRUE/> is set, <member>Step</member> contains a value greater 89*cdf0e10cSrcweir than or equal to 1, and <member>GroupBy</member> set to <const> 90*cdf0e10cSrcweir DataPilotFieldGroupBy::DAYS</const>, grouping is performed on ranges 91*cdf0e10cSrcweir of days (see descriptions for <member> 92*cdf0e10cSrcweir XDataPilotFieldGrouping::createDateGroup</member> for more details 93*cdf0e10cSrcweir about day grouping).</li> 94*cdf0e10cSrcweir </ul></p> 95*cdf0e10cSrcweir */ 96*cdf0e10cSrcweir boolean HasDateValues; 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir //------------------------------------------------------------------------- 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir /** specifies the start value for the grouping if <member>HasAutoStart 101*cdf0e10cSrcweir </member> is set to <FALSE/>. 102*cdf0e10cSrcweir */ 103*cdf0e10cSrcweir double Start; 104*cdf0e10cSrcweir 105*cdf0e10cSrcweir //------------------------------------------------------------------------- 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir /** specifies the end value for the grouping if <member>HasAutoEnd 108*cdf0e10cSrcweir </member> is set to <FALSE/>. 109*cdf0e10cSrcweir */ 110*cdf0e10cSrcweir double End; 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir //------------------------------------------------------------------------- 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir /** specifies the size of the ranges for numeric or day grouping. 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir <p>Example: With <member>HasAutoStart</member> set to <FALSE/>, 117*cdf0e10cSrcweir <member>Start</member> set to 2, and <member>Step</member> set to 3, 118*cdf0e10cSrcweir the first group will contain all values greater than or equal to 2 and 119*cdf0e10cSrcweir less than 5. The second group will contain all values greater than or 120*cdf0e10cSrcweir equal to 5 and less then 8, and so on.</p> 121*cdf0e10cSrcweir */ 122*cdf0e10cSrcweir double Step; 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir //------------------------------------------------------------------------- 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir /** specifies the grouping of the date values. 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir @see DataPilotFieldGroupBy 129*cdf0e10cSrcweir */ 130*cdf0e10cSrcweir long GroupBy; 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir //------------------------------------------------------------------------- 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir /** contains the source DataPilot field grouping is based on. Will be 135*cdf0e10cSrcweir <NULL/> if this field is not grouped or contains numeric grouping. 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir @see DataPilotField 138*cdf0e10cSrcweir */ 139*cdf0e10cSrcweir XDataPilotField SourceField; 140*cdf0e10cSrcweir 141*cdf0e10cSrcweir //------------------------------------------------------------------------- 142*cdf0e10cSrcweir 143*cdf0e10cSrcweir /** specifies the named groups in this field if there are some. 144*cdf0e10cSrcweir 145*cdf0e10cSrcweir <p>The returned object is an instance of <type>DataPilotFieldGroups 146*cdf0e10cSrcweir </type>. The collection of groups can be modified by inserting, 147*cdf0e10cSrcweir removing, replacing, or renaming single groups or item names in the 148*cdf0e10cSrcweir groups. When writing back this struct containing such a changed 149*cdf0e10cSrcweir collection of groups to the <member>DataPilotField::GroupInfo</member> 150*cdf0e10cSrcweir property, the modified grouping settings are applied at the DataPilot 151*cdf0e10cSrcweir field.</p> 152*cdf0e10cSrcweir 153*cdf0e10cSrcweir @see DataPilotField 154*cdf0e10cSrcweir @see DataPilotFieldGroups 155*cdf0e10cSrcweir */ 156*cdf0e10cSrcweir com::sun::star::container::XNameAccess Groups; 157*cdf0e10cSrcweir}; 158*cdf0e10cSrcweir 159*cdf0e10cSrcweir//============================================================================= 160*cdf0e10cSrcweir 161*cdf0e10cSrcweir}; }; }; }; 162*cdf0e10cSrcweir 163*cdf0e10cSrcweir#endif 164*cdf0e10cSrcweir 165