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
142
143
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_report_XGroup_idl__
#define __com_sun_star_report_XGroup_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#include <com/sun/star/report/XSection.idl>
#include <com/sun/star/report/XGroups.idl>
#include <com/sun/star/report/XFunctions.idl>
//=============================================================================
module com { module sun { module star { module report {
//=============================================================================
/** identifies a <type>XGroup</type>.
A group is always a child of the groups collection in the report.
@see XReportDefinition
@see XGroups
*/
published interface XGroup
{
/** allows access to the groups collection of the report.
*/
interface com::sun::star::container::XChild;
/** allows access to the properties of the instance.
*/
interface com::sun::star::beans::XPropertySet;
/** allows life-time control of group instances.
*/
interface com::sun::star::lang::XComponent;
/** gives access to functions defined in the group definition.
*/
interface XFunctionsSupplier;
/** Defines if the group is sorted ascending or descending.
The default is <TRUE/>.
*/
[attribute,bound] boolean SortAscending;
/** Defines if a group has a header.
*/
[attribute,bound] boolean HeaderOn;
/** Defines if a group has a footer.
*/
[attribute,bound] boolean FooterOn;
/** returns the group header.
@throws <type scope="com::sun::star::container">NoSuchElementException</type>
If the group has the header disabled.
@see XSection
*/
[attribute,readonly] XSection Header
{
get raises (com::sun::star::container::NoSuchElementException);
};
/** returns the group footer.
@throws <type scope="com::sun::star::container">NoSuchElementException</type>
If the group has the footer disabled.
@see XSection
*/
[attribute,readonly,bound] XSection Footer
{
get raises (com::sun::star::container::NoSuchElementException);
};
/** Specifies how to group data.
@see GroupOn
*/
[attribute,bound] short GroupOn
{
set raises (com::sun::star::lang::IllegalArgumentException);
};
/** Defines an interval value that rows are grouped by.
*/
[attribute,bound] long GroupInterval;
/** Specifies if a group header, detail, and footer section is printed on the same page.
@see KeepTogether
*/
[attribute,bound] short KeepTogether
{
set raises (com::sun::star::lang::IllegalArgumentException);
};
/** Specifies the parent of the group.
@see XChild
*/
[attribute,readonly] com::sun::star::report::XGroups Groups;
/** Defines either a column name or a expression.
*/
[attribute,bound] string Expression;
/** Specifies that the group header should always be printed on a new column.
*/
[attribute,bound] boolean StartNewColumn;
/** Specifies that the group header should always be printed on a new page and the reset of the page number to zero.
*/
[attribute,bound] boolean ResetPageNumber;
};
service Group : XGroup;
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif
|
