1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_report_XReportControlModel_idl__
28#define __com_sun_star_report_XReportControlModel_idl__
29
30#ifndef __com_sun_star_report_XReportComponent_idl__
31#include <com/sun/star/report/XReportComponent.idl>
32#endif
33#ifndef __com_sun_star_report_XReportControlFormat_idl__
34#include <com/sun/star/report/XReportControlFormat.idl>
35#endif
36#ifndef __com_sun_star_container_XContainer_idl__
37#include <com/sun/star/container/XContainer.idl>
38#endif
39#ifndef __com_sun_star_container_XIndexContainer_idl__
40#include <com/sun/star/container/XIndexContainer.idl>
41#endif
42#ifndef __com_sun_star_report_XFormatCondition_idl__
43#include <com/sun/star/report/XFormatCondition.idl>
44#endif
45//=============================================================================
46
47 module com {  module sun {  module star {  module report {
48
49//=============================================================================
50published interface XReportControlModel
51{
52    /** allows the creation of sub reports.
53    */
54    interface XReportComponent;
55
56    interface XReportControlFormat;
57
58    /** allows to register listeners to be notified of changes in the container.
59    */
60    interface com::sun::star::container::XContainer;
61
62    /** gives access to the <type scope="com::sun::star::report">XFormatCondition</type> elements by index.
63    */
64    interface com::sun::star::container::XIndexContainer;
65
66    /** Creates a format condition.
67        @return
68               report component
69    */
70    XFormatCondition createFormatCondition() raises( com::sun::star::uno::Exception );
71
72
73    /** Specifies which content should be shown.
74        The value can be <br/>
75        <li>the name of a database column. The format to use is field:[name] </li>
76        <li>the name of a function defined in the report or a group. The format to use is rpt:[functionName]</li>
77        <li>an expression like rpt:24+24-47</li>
78        @see http://wiki.services.openoffice.org/wiki/SUN_Report_Builder
79        @see http://wiki.services.openoffice.org/wiki/SUN_Report_Builder#Syntax
80        @see http://wiki.services.openoffice.org/wiki/Base/Reports/Functions
81    */
82    [attribute,bound] string DataField
83    {
84        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
85        get raises ( com::sun::star::beans::UnknownPropertyException );
86    };
87
88    /** Specifies that the element gets printed when the group changes.
89        The default value is <FALSE/>.
90    */
91    [attribute,bound] boolean PrintWhenGroupChange
92    {
93        set raises ( com::sun::star::beans::UnknownPropertyException );
94        get raises ( com::sun::star::beans::UnknownPropertyException );
95    };
96
97    /** Describes the print expression of the report control model.
98        If the expression evaluates to true than the report control model will be printed otherwise not.
99    */
100    [attribute,bound] string ConditionalPrintExpression
101    {
102        set raises ( com::sun::star::beans::UnknownPropertyException );
103        get raises ( com::sun::star::beans::UnknownPropertyException );
104    };
105};
106
107service ReportControlModel : XReportControlModel;
108//=============================================================================
109
110}; }; }; };
111
112/*=============================================================================
113
114=============================================================================*/
115#endif
116