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