INTEGRATION: CWS oj14 (1.1.2); FILE ADDED

2007/04/27 10:55:33 oj 1.1.2.1: #i76758# new report api

2 files changed, 303 insertions, 0 deletions

diff --git a/offapi/com/sun/star/report/XSection.idl b/offapi/com/sun/star/report/XSection.idl
new file mode 100644
index 000000000000..2aa6b7e77c92
--- /dev/null
+++ b/offapi/com/sun/star/report/XSection.idl
@@ -0,0 +1,203 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XSection.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:22:46 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_report_XSection_idl__
+#define __com_sun_star_report_XSection_idl__
+
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+#ifndef __com_sun_star_drawing_XShapes_idl__
+#include <com/sun/star/drawing/XShapes.idl>
+#endif
+#ifndef __com_sun_star_container_XEnumerationAccess_idl__
+#include <com/sun/star/container/XEnumerationAccess.idl>
+#endif
+#ifndef __com_sun_star_container_XContainer_idl__
+#include <com/sun/star/container/XContainer.idl>
+#endif
+#ifndef __com_sun_star_util_Color_idl__
+#include <com/sun/star/util/Color.idl>
+#endif
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+#ifndef __com_sun_star_report_XReportDefinition_idl__
+#include <com/sun/star/report/XReportDefinition.idl>
+#endif
+#ifndef __com_sun_star_report_XReportComponent_idl__
+#include <com/sun/star/report/XReportComponent.idl>
+#endif
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+ interface XGroup;
+//=============================================================================
+
+/** identifies a <type>XSection</type> inside a report.
+
+    <p>A section acts like a container of report components. This generic
+    construction allows the definition of hierarchies of reports and their
+    dependent subreports.</p>
+
+    @see XReportDefinition
+    @see XGroup
+ */
+interface XSection
+{
+    /** allows to navigate to group or report definition.
+    */
+    interface com::sun::star::container::XChild;
+    /** allows to register listeners to be notified of changes in the container.
+    */
+    interface com::sun::star::container::XContainer;
+
+    /** gives access to the elements by index.
+    */
+    interface com::sun::star::drawing::XShapes;
+
+    /** creates an enumeration of the elements.
+    */
+    interface com::sun::star::container::XEnumerationAccess;
+
+    /** provides generic access to the instance properties
+    */
+    interface com::sun::star::beans::XPropertySet;
+
+    /** allows life-time control of sections.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    //-------------------------------------------------------------------------
+
+    /** Defines if the section should be visible in report.
+    */
+    [attribute,bound] boolean Visible;
+
+    /** Defines the name of the section.
+    */
+    [attribute,bound] string Name;
+
+    /** Defines the height of the section.
+    */
+    [attribute,bound] unsigned long Height;
+
+    /** Defines the back ground color of the section.
+    */
+    [attribute,bound] com::sun::star::util::Color BackColor;
+
+    /** determines if the back ground color is set to transparent.
+     */
+    [attribute,bound] boolean BackTransparent;
+
+    /** Defines the expression which is executed before printing the section.
+        If the return value of the expression is <TRUE/> then the section will be printed.
+    */
+    [attribute,bound] string ConditionalPrintExpression;
+
+    /** Specifies wether the section is printed on a separate page.
+        <p>Not valid for page header or page footer.</p>
+        @see ForceNewPage
+    */
+    [attribute,bound] short ForceNewPage
+    {
+        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+        get raises ( com::sun::star::beans::UnknownPropertyException );
+    };
+
+    /** Specifies wether the section is printed in a new row or column within a multi column report.
+        <p>Not valid for page header or page footer.</p>
+        @see ForceNewPage
+    */
+    [attribute,bound] short NewRowOrCol
+    {
+        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+        get raises ( com::sun::star::beans::UnknownPropertyException );
+    };
+
+    /** Specifies that the section is printed on one page.
+    <p>Not valid for page header or page footer.</p>
+    */
+    [attribute,bound] boolean KeepTogether
+    {
+        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+        get raises ( com::sun::star::beans::UnknownPropertyException );
+    };
+
+    /** Specifies that elements with dynamic state will be expanded vertically when then content of the element is larger than it's container.
+        If this property is disabled the content will be truncated when it's size is larger than the container.
+    */
+    [attribute,bound] boolean CanGrow
+    {
+        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+        get raises ( com::sun::star::beans::UnknownPropertyException );
+    };
+
+/**
+  <p>Represents ...</p>
+
+ */
+    [attribute,bound] boolean CanShrink
+    {
+        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+        get raises ( com::sun::star::beans::UnknownPropertyException );
+    };
+
+    /** Defines that the group header should be repeated on the next page when a group spans more than one page.
+        It only applies to group headers.
+    */
+    [attribute,bound] boolean RepeatSection
+    {
+        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+        get raises ( com::sun::star::beans::UnknownPropertyException );
+    };
+
+    /** Specifies the parent of the section if it is a group header or group footer.
+    */
+    [attribute,readonly] com::sun::star::report::XGroup Group;
+
+    /** Specifies the parent of the section if it is a page header or page footer.
+    */
+    [attribute,readonly] com::sun::star::report::XReportDefinition ReportDefinition;
+};
+
+service Section : XSection;
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif
diff --git a/offapi/com/sun/star/report/XShape.idl b/offapi/com/sun/star/report/XShape.idl
new file mode 100644
index 000000000000..aebd731c1206
--- /dev/null
+++ b/offapi/com/sun/star/report/XShape.idl
@@ -0,0 +1,100 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XShape.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:23:02 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_report_XShape_idl__
+#define __com_sun_star_report_XShape_idl__
+
+#ifndef __com_sun_star_report_XReportControlModel_idl__
+#include <com/sun/star/report/XReportControlModel.idl>
+#endif
+#ifndef __com_sun_star_beans_PropertyValue_idl__
+#include <com/sun/star/beans/PropertyValue.idl>
+#endif
+#ifndef __com_sun_star_drawing_XShape_idl__
+#include <com/sun/star/drawing/XShape.idl>
+#endif
+#ifndef __com_sun_star_drawing_HomogenMatrix3_idl__
+#include <com/sun/star/drawing/HomogenMatrix3.idl>
+#endif
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+
+//=============================================================================
+interface XShape
+{
+    interface XReportControlModel;
+
+    /** is used to query or change the ZOrder of this <type>Shape</type>. */
+    [attribute,bound] long ZOrder;
+
+    /** this property lets you get and set the transformation matrix
+        for this shape.
+
+        The transformation is a 3x3 homogen matrix and can contain
+        translation, rotation, shearing and scaling.
+     */
+    [attribute,bound] com::sun::star::drawing::HomogenMatrix3 Transformation;
+
+    //-------------------------------------------------------------------------
+    /** This property contains the CustomShapeEngine service name that has to
+        be used for rendering.
+    */
+    [attribute] string CustomShapeEngine;
+
+    //-------------------------------------------------------------------------
+    /** This property can be used to store data that the CustomShapeEngine may
+        use for rendering
+    */
+    [attribute] string CustomShapeData;
+
+    /** This property describes the geometry of the CustomShape. The CustomShapeEngine
+        that is used should be able to get on with the content of this property.
+
+        If the CustomShapeEngine property is "com.sun.star.drawing.EnhancedCustomShapeEngine",
+        then this property is containing properties as they are specified in the service
+        com.sun.star.drawing.EnhancedCustomShapeGeometry
+    */
+    [attribute,bound] sequence<::com::sun::star::beans::PropertyValue> CustomShapeGeometry;
+};
+
+service Shape : XShape;
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif