offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__
  21 #define __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__
  22
  23 #include <com/sun/star/sheet/XDataPilotField.idl>
  24 #include <com/sun/star/container/XNameAccess.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** contains the grouping information of a DataPilotField.
  31  */
  32 published struct DataPilotFieldGroupInfo
  33 {
  34
  35     /** specifies whether the start value for the grouping is taken
  36         automatically from the minimum of the item values.
  37
  38         <p><ul>
  39         <li>If `FALSE` is set, the value from #Start will be
  40         used as start value for the grouping.</li>
  41         <li>If `TRUE` is set, the start value for the grouping will be
  42         calculated automatically from the minimum of all member values of the
  43         DataPilot field.</li>
  44         </ul></p>
  45      */
  46     boolean HasAutoStart;
  47
  48
  49     /** specifies whether the end value for the grouping is taken
  50         automatically from the maximum of the item values.
  51
  52         <p><ul>
  53         <li>If `FALSE` is set, the value from #End will be
  54         used as end value for the grouping.</li>
  55         <li>If `TRUE` is set, the end value for the grouping will be
  56         calculated automatically from the maximum of all member values of the
  57         DataPilot field.</li>
  58         </ul></p>
  59      */
  60     boolean HasAutoEnd;
  61
  62
  63     /** specifies whether date values are grouped by ranges of days.
  64
  65         <p><ul>
  66         <li>If `FALSE` is set, and #GroupBy contains zero,
  67         grouping is performed inplace on the item values.</li>
  68         <li>If `FALSE` is set, and #GroupBy contains one or
  69         more flags from DataPilotFieldGroupBy, grouping is
  70         performed on date or time.</li>
  71         <li>If `TRUE` is set, #Step contains a value greater
  72         than or equal to 1, and #GroupBy set to
  73         DataPilotFieldGroupBy::DAYS, grouping is performed on ranges
  74         of days (see descriptions for
  75         XDataPilotFieldGrouping::createDateGroup() for more details
  76         about day grouping).</li>
  77         </ul></p>
  78      */
  79     boolean HasDateValues;
  80
  81
  82     /** specifies the start value for the grouping if #HasAutoStart
  83         is set to `FALSE`.
  84      */
  85     double Start;
  86
  87
  88     /** specifies the end value for the grouping if #HasAutoEnd
  89         is set to `FALSE`.
  90      */
  91     double End;
  92
  93
  94     /** specifies the size of the ranges for numeric or day grouping.
  95
  96         <p>Example: With #HasAutoStart set to `FALSE`,
  97         #Start set to 2, and #Step set to 3,
  98         the first group will contain all values greater than or equal to 2 and
  99         less than 5. The second group will contain all values greater than or
 100         equal to 5 and less then 8, and so on.</p>
 101      */
 102     double Step;
 103
 104
 105     /** specifies the grouping of the date values.
 106
 107         @see DataPilotFieldGroupBy
 108      */
 109     long GroupBy;
 110
 111
 112     /** contains the source DataPilot field grouping is based on. Will be
 113         `NULL` if this field is not grouped or contains numeric grouping.
 114
 115         @see DataPilotField
 116      */
 117     XDataPilotField SourceField;
 118
 119
 120     /** specifies the named groups in this field if there are some.
 121
 122         <p>The returned object is an instance of DataPilotFieldGroups
 123         . The collection of groups can be modified by inserting,
 124         removing, replacing, or renaming single groups or item names in the
 125         groups. When writing back this struct containing such a changed
 126         collection of groups to the DataPilotField::GroupInfo
 127         property, the modified grouping settings are applied at the DataPilot
 128         field.</p>
 129
 130         @see DataPilotField
 131         @see DataPilotFieldGroups
 132      */
 133     com::sun::star::container::XNameAccess Groups;
 134 };
 135
 136
 137 }; }; }; };
 138
 139 #endif
 140
 141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */