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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*************************************************************************
*
* 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_XReportComponent_idl__
#define __com_sun_star_report_XReportComponent_idl__
#include <com/sun/star/container/XChild.idl>
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/container/XNamed.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/util/XCloneable.idl>
#include <com/sun/star/awt/XControlModel.idl>
#include <com/sun/star/drawing/XShape.idl>
//=============================================================================
module com { module sun { module star { module report {
interface XSection;
//=============================================================================
/** describes a component which may be part of a report.
@see XReportDefinition
*/
interface XReportComponent
{
interface com::sun::star::util::XCloneable;
/** identifies the component as a candidate for being part of a report.
<p>This interface also provides the access to the component's parent.</p>
*/
interface com::sun::star::container::XChild;
/** allows life-time control of report components.
*/
interface com::sun::star::lang::XComponent;
interface com::sun::star::drawing::XShape;
/** gives access to the properties.
*/
interface com::sun::star::beans::XPropertySet;
/** the name of the component.
*/
[attribute,bound] string Name
{
set raises ( com::sun::star::beans::PropertyVetoException );
};
/** specifies the height of the control.
*/
[attribute,bound] long Height;
/** specifies the horizontal position of the control.
*/
[attribute,bound] long PositionX;
/** specifies the vertical position of the control.
*/
[attribute,bound] long PositionY;
/** specifies the width of the control.
*/
[attribute,bound] long Width;
/** specifies the border style of the control.
<pre>
0: No border
2: simple border
</pre>
*/
[attribute,bound] short ControlBorder
{
set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
//-------------------------------------------------------------------------
/** specifies the color of the border, if present
<p>Not every border style (see <member>Border</member>) may support coloring.
For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
*/
[attribute,bound] long ControlBorderColor
{
set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** Specifies that recurring values are printed.
If set to <TRUE/> then the value will be printed every time. If set to <FALSE/> then the value will only be printed once.
The default value is <TRUE/>.
*/
[attribute,bound] boolean PrintRepeatedValues
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** is used for subreports and contains the names of columns of the parent report.
<p> These columns are typically the foreign key fields of the parent report.
The values of theses columns are used to identify the data for the subreport.
Each time the parent report changes it's current row, the subreport requeries
it's data based on the values of the master fields.</p>
<p>If the report is no sub report (e.g. it's parent is not a report itself), this
property is not evaluated.</p>
*/
[attribute,bound] sequence<string> MasterFields
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/**is used for subreports and contains the names of the columns of the subreport
which are related to the master fields of the parent report.
<p>Entries in this sequence can either denote column names in the sub report,
or parameter names.<br/>
For instance, you could base the report on the SQL statement
<code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code>
to the DetailFields property. In this case, the parameter will be filled from
the corresponding master field.<br/>
Alternatively, you could simply base your report on the table <code>invoices</code>,
and add the column name <code>cust_ref</code> to the DetailFields. In this case,
and implicit filter clause <code>WHERE cust_ref = :<new_param_name></code> will
be created, and the artificial parameter will be filled from the corresponding
master field.<br/>
If a string in this property denotes both a column name and a parameter name, it
is undefined which way it is interpreted, but implementations of the service are required
to either decide for the parameter or the column, and proceed as usual.
</p>
<p>The columns specified herein typically represent a part of the primary key
fields or their aliases of the detail report.</p>
<p>If the report is no sub report (e.g. it's parent is not a report itself), this
property is not evaluated.</p>
*
*/
[attribute,bound] sequence<string> DetailFields
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** Specifies the section where the control belongs to.
This is a shortcut to get control hierarchy up.
This value is <NULL/> when the control was not inserted in any section.
*/
[attribute,readonly] com::sun::star::report::XSection Section;
};
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif
|
