1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_report_XReportComponent_idl__
25#define __com_sun_star_report_XReportComponent_idl__
26
27#ifndef __com_sun_star_container_XChild_idl__
28#include <com/sun/star/container/XChild.idl>
29#endif
30
31#ifndef __com_sun_star_lang_XComponent_idl__
32#include <com/sun/star/lang/XComponent.idl>
33#endif
34
35#ifndef __com_sun_star_container_XNamed_idl__
36#include <com/sun/star/container/XNamed.idl>
37#endif
38
39#ifndef __com_sun_star_beans_XPropertySet_idl__
40#include <com/sun/star/beans/XPropertySet.idl>
41#endif
42#ifndef __com_sun_star_util_XCloneable_idl__
43#include <com/sun/star/util/XCloneable.idl>
44#endif
45#ifndef __com_sun_star_awt_XControlModel_idl__
46#include <com/sun/star/awt/XControlModel.idl>
47#endif
48#ifndef __com_sun_star_drawing_XShape_idl__
49#include <com/sun/star/drawing/XShape.idl>
50#endif
51
52//=============================================================================
53
54 module com {  module sun {  module star {  module report {
55
56published interface XSection;
57
58//=============================================================================
59/** describes a component which may be part of a report.
60
61    @see XReportDefinition
62 */
63published interface XReportComponent
64{
65    interface com::sun::star::util::XCloneable;
66    /** identifies the component as a candidate for being part of a report.
67        <p>This interface also provides the access to the component's parent.</p>
68     */
69    interface com::sun::star::container::XChild;
70
71    /** allows life-time control of report components.
72     */
73    interface com::sun::star::lang::XComponent;
74
75    interface com::sun::star::drawing::XShape;
76
77    /** gives access to the properties.
78    */
79    interface com::sun::star::beans::XPropertySet;
80
81    /** the name of the component.
82     */
83    [attribute,bound] string Name
84    {
85        set raises ( com::sun::star::beans::PropertyVetoException );
86    };
87
88    /** specifies the height of the control.
89     */
90    [attribute,bound] long Height;
91
92    /** specifies the horizontal position of the control.
93     */
94    [attribute,bound] long PositionX;
95
96    /** specifies the vertical position of the control.
97     */
98    [attribute,bound] long PositionY;
99
100    /** specifies the width of the control.
101     */
102    [attribute,bound] long Width;
103
104    /** specifies the border style of the control.
105
106        <pre>
107        0: No border
108        2: simple border
109        </pre>
110     */
111    [attribute,bound] short ControlBorder
112    {
113        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
114        get raises ( com::sun::star::beans::UnknownPropertyException );
115    };
116
117    //-------------------------------------------------------------------------
118
119    /** specifies the color of the border, if present
120
121        <p>Not every border style (see <member>Border</member>) may support coloring.
122        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
123     */
124    [attribute,bound] long ControlBorderColor
125    {
126        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
127        get raises ( com::sun::star::beans::UnknownPropertyException );
128    };
129
130    /** Specifies that recurring values are printed.
131        If set to <TRUE/> then the value will be printed every time. If set to <FALSE/> then the value will only be printed once.
132        The default value is <TRUE/>.
133    */
134    [attribute,bound] boolean PrintRepeatedValues
135    {
136        set raises ( com::sun::star::beans::UnknownPropertyException );
137        get raises ( com::sun::star::beans::UnknownPropertyException );
138    };
139
140        /** is used for subreports and contains the names of columns of the parent report.
141    <p> These columns are typically the foreign key fields of the parent report.
142    The values of theses columns are used to identify the data for the subreport.
143    Each time the parent report changes it's current row, the subreport requires
144    its data based on the values of the master fields.</p>
145    <p>If the report is no sub report (e.g. its parent is not a report itself), this
146    property is not evaluated.</p>
147
148    */
149    [attribute,bound] sequence<string> MasterFields
150    {
151        set raises ( com::sun::star::beans::UnknownPropertyException );
152        get raises ( com::sun::star::beans::UnknownPropertyException );
153    };
154
155    /**is used for subreports and contains the names of the columns of the subreport
156    which are related to the master fields of the parent report.
157    <p>Entries in this sequence can either denote column names in the sub report,
158    or parameter names.<br/>
159    For instance, you could base the report on the SQL statement
160    <code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code>
161    to the DetailFields property. In this case, the parameter will be filled from
162    the corresponding master field.<br/>
163    Alternatively, you could simply base your report on the table <code>invoices</code>,
164    and add the column name <code>cust_ref</code> to the DetailFields. In this case,
165    and implicit filter clause <code>WHERE cust_ref = :&lt;new_param_name&gt;</code> will
166    be created, and the artificial parameter will be filled from the corresponding
167    master field.<br/>
168    If a string in this property denotes both a column name and a parameter name, it
169    is undefined which way it is interpreted, but implementations of the service are required
170    to either decide for the parameter or the column, and proceed as usual.
171    </p>
172    <p>The columns specified herein typically represent a part of the primary key
173    fields or their aliases of the detail report.</p>
174    <p>If the report is no sub report (e.g. it's parent is not a report itself), this
175    property is not evaluated.</p>
176    *
177    */
178    [attribute,bound] sequence<string> DetailFields
179    {
180        set raises ( com::sun::star::beans::UnknownPropertyException );
181        get raises ( com::sun::star::beans::UnknownPropertyException );
182    };
183
184
185    /** Specifies the section where the control belongs to.
186        This is a shortcut to get control hierarchy up.
187        This value is <NULL/> when the control was not inserted in any section.
188    */
189    [attribute,readonly] com::sun::star::report::XSection Section;
190};
191
192//=============================================================================
193
194}; }; }; };
195
196/*=============================================================================
197
198=============================================================================*/
199#endif
200