INTEGRATION: CWS oj14 (1.1.2); FILE ADDED

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

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFunctions.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:20:41 $
+ *
+ *  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_XFunctions_idl__
+#define __com_sun_star_report_XFunctions_idl__
+
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+#ifndef __com_sun_star_container_XContainer_idl__
+#include <com/sun/star/container/XContainer.idl>
+#endif
+#ifndef __com_sun_star_container_XIndexContainer_idl__
+#include <com/sun/star/container/XIndexContainer.idl>
+#endif
+#ifndef __com_sun_star_lang_XComponent_idl__
+#include <com/sun/star/lang/XComponent.idl>
+#endif
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+interface XReportDefinition;
+interface XFunction;
+//=============================================================================
+
+/** This interface specifies the functions collections of the report definition or a group.
+    @see XFunction
+    @see XReportDefinition
+ */
+interface XFunctions
+{
+    /** allows to register listeners to be notified of changes in the container.
+    */
+    interface com::sun::star::container::XContainer;
+    /** gives access to the group elements.
+        The elements are of type <type>XFunction</type>.
+    */
+    interface com::sun::star::container::XIndexContainer;
+
+    /** allows the navigation to the report or group object.
+        The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
+    */
+    interface com::sun::star::container::XChild;
+
+    /** allows life-time control of the functions instance.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    /** factory method for <type>XFunction</type>.
+    */
+    com::sun::star::report::XFunction createFunction();
+};
+
+//=============================================================================
+}; }; }; };
+
+#endif

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFunctionsSupplier.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:20:52 $
+ *
+ *  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_XFunctionsSupplier_idl__
+#define __com_sun_star_report_XFunctionsSupplier_idl__
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
+#endif
+//=============================================================================
+ module com {  module sun {  module star {  module report {
+//=============================================================================
+     interface XFunctions;
+/** specifies the functions supplier which are located in a report defintion or a group.
+*/
+interface XFunctionsSupplier
+{
+    /** access to the functions
+    */
+    [attribute,readonly] com::sun::star::report::XFunctions Functions;
+};
+//=============================================================================
+
+}; }; }; };
+#endif

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XGroup.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:21:03 $
+ *
+ *  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_XGroup_idl__
+#define __com_sun_star_report_XGroup_idl__
+
+#ifndef __com_sun_star_container_NoSuchElementException_idl__
+#include <com/sun/star/container/NoSuchElementException.idl>
+#endif
+#ifndef __com_sun_star_report_XSection_idl__
+#include <com/sun/star/report/XSection.idl>
+#endif
+#ifndef __com_sun_star_report_XGroups_idl__
+#include <com/sun/star/report/XGroups.idl>
+#endif
+#include <com/sun/star/report/XFunctions.idl>
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+
+//=============================================================================
+
+/** identifies a <type>XGroup</type>.
+    A group is always a child of the groups collection in the report.
+    @see XReportDefinition
+    @see XGroups
+ */
+interface XGroup
+{
+    /** allows access to the groups collection of the report.
+    */
+    interface com::sun::star::container::XChild;
+
+    /** allows access to the properties of the instance.
+    */
+    interface com::sun::star::beans::XPropertySet;
+
+    /** allows life-time control of group instances.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    /** gives access to functions defined in the group definition.
+    */
+    interface XFunctionsSupplier;
+
+    /** Defines if the group is sorted ascending or descending.
+        The default is <TRUE/>.
+     */
+    [attribute,bound] boolean SortAscending;
+
+    /** Defines if a group has a header.
+    */
+    [attribute,bound] boolean HeaderOn;
+
+    /** Defines if a group has a footer.
+    */
+    [attribute,bound] boolean FooterOn;
+
+    /** returns the group header.
+        @throws <type scope="com::sun::star::container">NoSuchElementException</type>
+            If the group has the header disabled.
+        @see XSection
+    */
+
+    [attribute,readonly] XSection Header
+    {
+        get raises (com::sun::star::container::NoSuchElementException);
+    };
+
+    /** returns the group footer.
+        @throws <type scope="com::sun::star::container">NoSuchElementException</type>
+            If the group has the footer disabled.
+        @see XSection
+    */
+    [attribute,readonly,bound] XSection Footer
+    {
+        get raises (com::sun::star::container::NoSuchElementException);
+    };
+
+    /** Specifies how to group data.
+        @see GroupOn
+    */
+    [attribute,bound] short GroupOn
+    {
+        set raises (com::sun::star::lang::IllegalArgumentException);
+    };
+
+    /** Defines an interval value that rows are grouped by.
+    */
+    [attribute,bound] long GroupInterval;
+
+    /** Specifies if a group header, detail, and footer section is printed on the same page.
+        @see KeepTogether
+    */
+    [attribute,bound] short KeepTogether
+    {
+        set raises (com::sun::star::lang::IllegalArgumentException);
+    };
+
+    /** Specifies the parent of the group.
+        @see XChild
+    */
+    [attribute,readonly] com::sun::star::report::XGroups Groups;
+
+    /** Defines either a column name or a expression.
+    */
+    [attribute,bound] string Expression;
+
+    /** Specifies that the group header should always be printed on a new column.
+    */
+    [attribute,bound] boolean StartNewColumn;
+
+    /** Specifies that the group header should always be printed on a new page and the reset of the page number to zero.
+    */
+    [attribute,bound] boolean ResetPageNumber;
+};
+
+service Group : XGroup;
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif

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

+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XGroups.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:21:19 $
+ *
+ *  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_XGroups_idl__
+#define __com_sun_star_report_XGroups_idl__
+
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+#ifndef __com_sun_star_container_XContainer_idl__
+#include <com/sun/star/container/XContainer.idl>
+#endif
+#ifndef __com_sun_star_container_XIndexContainer_idl__
+#include <com/sun/star/container/XIndexContainer.idl>
+#endif
+#ifndef __com_sun_star_lang_XComponent_idl__
+#include <com/sun/star/lang/XComponent.idl>
+#endif
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+interface XReportDefinition;
+interface XGroup;
+//=============================================================================
+
+/** This interface specifies the groups collections of the report definition.
+    @see XGroup
+    @see XReportDefinition
+ */
+interface XGroups
+{
+    /** allows to register listeners to be notified of changes in the container.
+    */
+    interface com::sun::star::container::XContainer;
+    /** gives access to the group elements.
+        The elements are of type <type>XGroup</type>.
+    */
+    interface com::sun::star::container::XIndexContainer;
+
+    /** allows the navigation to the report object.
+    */
+    interface com::sun::star::container::XChild;
+
+    /** allows life-time control of the groups instance.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    /** factory method for <type>XGroup</type>.
+    */
+    com::sun::star::report::XGroup createGroup();
+
+    [attribute,readonly] com::sun::star::report::XReportDefinition ReportDefinition;
+};
+
+service Groups : XGroups;
+//=============================================================================
+
+}; }; }; };
+
+#endif