offapi/com/sun/star/report/XReportControlModel.idl

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