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