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