diff options
Diffstat (limited to 'offapi/com/sun/star/report/XReportComponent.idl')
-rw-r--r-- | offapi/com/sun/star/report/XReportComponent.idl | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/offapi/com/sun/star/report/XReportComponent.idl b/offapi/com/sun/star/report/XReportComponent.idl new file mode 100644 index 000000000000..e3098a2246e8 --- /dev/null +++ b/offapi/com/sun/star/report/XReportComponent.idl @@ -0,0 +1,200 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_report_XReportComponent_idl__ +#define __com_sun_star_report_XReportComponent_idl__ + +#ifndef __com_sun_star_container_XChild_idl__ +#include <com/sun/star/container/XChild.idl> +#endif + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_util_XCloneable_idl__ +#include <com/sun/star/util/XCloneable.idl> +#endif +#ifndef __com_sun_star_awt_XControlModel_idl__ +#include <com/sun/star/awt/XControlModel.idl> +#endif +#ifndef __com_sun_star_drawing_XShape_idl__ +#include <com/sun/star/drawing/XShape.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module report { + interface XSection; +//============================================================================= +/** describes a component which may be part of a report. + + @see XReportDefinition + */ +interface XReportComponent +{ + interface com::sun::star::util::XCloneable; + /** identifies the component as a candidate for being part of a report. + <p>This interface also provides the access to the component's parent.</p> + */ + interface com::sun::star::container::XChild; + + /** allows life-time control of report components. + */ + interface com::sun::star::lang::XComponent; + + interface com::sun::star::drawing::XShape; + + /** gives access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + /** the name of the component. + */ + [attribute,bound] string Name + { + set raises ( com::sun::star::beans::PropertyVetoException ); + }; + + /** specifies the height of the control. + */ + [attribute,bound] long Height; + + /** specifies the horizontal position of the control. + */ + [attribute,bound] long PositionX; + + /** specifies the vertical position of the control. + */ + [attribute,bound] long PositionY; + + /** specifies the width of the control. + */ + [attribute,bound] long Width; + + /** specifies the border style of the control. + + <pre> + 0: No border + 2: simple border + </pre> + */ + [attribute,bound] short ControlBorder + { + set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the color of the border, if present + + <p>Not every border style (see <member>Border</member>) may support coloring. + For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> + */ + [attribute,bound] long ControlBorderColor + { + set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** Specifies that recurring values are printed. + If set to <TRUE/> then the value will be printed every time. If set to <FALSE/> then the value will only be printed once. + The default value is <TRUE/>. + */ + [attribute,bound] boolean PrintRepeatedValues + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** is used for subreports and contains the names of columns of the parent report. + <p> These columns are typically the foreign key fields of the parent report. + The values of theses columns are used to identify the data for the subreport. + Each time the parent report changes it's current row, the subreport requeries + it's data based on the values of the master fields.</p> + <p>If the report is no sub report (e.g. it's parent is not a report itself), this + property is not evaluated.</p> + + */ + [attribute,bound] sequence<string> MasterFields + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /**is used for subreports and contains the names of the columns of the subreport + which are related to the master fields of the parent report. + <p>Entries in this sequence can either denote column names in the sub report, + or paramater names.<br/> + For instance, you could base the report on the SQL statement + <code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code> + to the DetailFields property. In this case, the parameter will be filled from + the corresponding master field.<br/> + Alternatively, you could simply base your report on the table <code>invoices</code>, + and add the column name <code>cust_ref</code> to the DetailFields. In this case, + and implicit filter clause <code>WHERE cust_ref = :<new_param_name></code> will + be created, and the artificial parameter will be filled from the corresponding + master field.<br/> + If a string in this property denotes both a column name and a parameter name, it + is undefined which way it is interpreted, but implementations of the service are required + to either decide for the paramter or the column, and proceed as usual. + </p> + <p>The columns specified herein typically represent a part of the primary key + fields or their aliases of the detail report.</p> + <p>If the report is no sub report (e.g. it's parent is not a report itself), this + property is not evaluated.</p> + * + */ + [attribute,bound] sequence<string> DetailFields + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + + /** Specifies the section where the control belongs to. + This is a shortcut to get control hierachy up. + This value is <NULL/> when the control was not inserted in any section. + */ + [attribute,readonly] com::sun::star::report::XSection Section; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif |