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