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