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_XReportControlModel_idl__
25#define __com_sun_star_report_XReportControlModel_idl__
26
27#ifndef __com_sun_star_report_XReportComponent_idl__
28#include <com/sun/star/report/XReportComponent.idl>
29#endif
30#ifndef __com_sun_star_report_XReportControlFormat_idl__
31#include <com/sun/star/report/XReportControlFormat.idl>
32#endif
33#ifndef __com_sun_star_container_XContainer_idl__
34#include <com/sun/star/container/XContainer.idl>
35#endif
36#ifndef __com_sun_star_container_XIndexContainer_idl__
37#include <com/sun/star/container/XIndexContainer.idl>
38#endif
39#ifndef __com_sun_star_report_XFormatCondition_idl__
40#include <com/sun/star/report/XFormatCondition.idl>
41#endif
42
43//=============================================================================
44
45 module com { module sun { module star { module report {
46
47//=============================================================================
48published interface XReportControlModel
49{
50	/** allows the creation of sub reports.
51	*/
52	interface XReportComponent;
53
54	interface XReportControlFormat;
55
56	/** allows to register listeners to be notified of changes in the container.
57	*/
58	interface com::sun::star::container::XContainer;
59
60	/** gives access to the <type scope="com::sun::star::report">XFormatCondition</type> elements by index.
61	*/
62	interface com::sun::star::container::XIndexContainer;
63
64	/** Creates a format condition.
65		@return
66			   report component
67	*/
68	XFormatCondition createFormatCondition() raises( com::sun::star::uno::Exception );
69
70
71	/** Specifies which content should be shown.
72		The value can be <br/>
73		<li>the name of a database column. The format to use is field:[name] </li>
74		<li>the name of a function defined in the report or a group. The format to use is rpt:[functionName]</li>
75		<li>an expression like rpt:24+24-47</li>
76		@see https://wiki.openoffice.org/wiki/SUN_Report_Builder
77		@see https://wiki.openoffice.org/wiki/SUN_Report_Builder#Syntax
78		@see https://wiki.openoffice.org/wiki/Base/Reports/Functions
79	*/
80	[attribute,bound] string DataField
81	{
82		set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
83		get raises ( com::sun::star::beans::UnknownPropertyException );
84	};
85
86	/** Specifies that the element gets printed when the group changes.
87		The default value is <FALSE/>.
88	*/
89	[attribute,bound] boolean PrintWhenGroupChange
90	{
91		set raises ( com::sun::star::beans::UnknownPropertyException );
92		get raises ( com::sun::star::beans::UnknownPropertyException );
93	};
94
95	/** Describes the print expression of the report control model.
96		If the expression evaluates to true than the report control model will be printed otherwise not.
97	*/
98	[attribute,bound] string ConditionalPrintExpression
99	{
100		set raises ( com::sun::star::beans::UnknownPropertyException );
101		get raises ( com::sun::star::beans::UnknownPropertyException );
102	};
103};
104
105//=============================================================================
106
107}; }; }; };
108
109/*=============================================================================
110
111=============================================================================*/
112#endif
113
114