INTEGRATION: CWS oj14 (1.1.2); FILE ADDED

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

4 files changed, 314 insertions, 0 deletions

diff --git a/offapi/com/sun/star/report/XFixedText.idl b/offapi/com/sun/star/report/XFixedText.idl
new file mode 100644
index 000000000000..e128c23da1ff
--- /dev/null
+++ b/offapi/com/sun/star/report/XFixedText.idl
@@ -0,0 +1,67 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFixedText.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:19:50 $
+ *
+ *  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_XFixedText_idl__
+#define __com_sun_star_report_XFixedText_idl__
+
+#ifndef __com_sun_star_report_XReportControlModel_idl__
+#include <com/sun/star/report/XReportControlModel.idl>
+#endif
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+
+//=============================================================================
+interface XFixedText
+{
+    interface XReportControlModel;
+
+    /** specifies the label of the control.
+     */
+    [attribute,bound] string Label;
+
+    /** specifies that the text may be displayed on more than one line.
+     */
+    [attribute,bound] boolean MultiLine;
+};
+
+service FixedText : XFixedText;
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif
diff --git a/offapi/com/sun/star/report/XFormatCondition.idl b/offapi/com/sun/star/report/XFormatCondition.idl
new file mode 100644
index 000000000000..c5c1426e760a
--- /dev/null
+++ b/offapi/com/sun/star/report/XFormatCondition.idl
@@ -0,0 +1,69 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFormatCondition.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:20:06 $
+ *
+ *  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_XFormatCondition_idl__
+#define __com_sun_star_report_XFormatCondition_idl__
+
+#ifndef __com_sun_star_report_XReportControlFormat_idl__
+#include <com/sun/star/report/XReportControlFormat.idl>
+#endif
+
+//=============================================================================
+ module com {  module sun {  module star {  module report {
+//=============================================================================
+/** specifies a format condition for a control.
+*/
+interface XFormatCondition
+{
+    interface XReportControlFormat;
+
+    /** gives access to the properties.
+    */
+    interface com::sun::star::beans::XPropertySet;
+
+    /** specifies if the condition is enabled or not.
+    */
+    [attribute,bound] boolean Enabled;
+
+    /** defines the formula of the format condition.
+        If the formula evaluates to <TRUE/> then the format will be applied.
+    */
+    [attribute,bound] string Formula;
+};
+
+service FormatCondition : XFormatCondition;
+//=============================================================================
+
+}; }; }; };
+#endif
diff --git a/offapi/com/sun/star/report/XFormattedField.idl b/offapi/com/sun/star/report/XFormattedField.idl
new file mode 100644
index 000000000000..e3f9fd9217b3
--- /dev/null
+++ b/offapi/com/sun/star/report/XFormattedField.idl
@@ -0,0 +1,80 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFormattedField.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:20: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_XFormattedField_idl__
+#define __com_sun_star_report_XFormattedField_idl__
+
+#ifndef __com_sun_star_report_XReportControlModel_idl__
+#include <com/sun/star/report/XReportControlModel.idl>
+#endif
+#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
+#include <com/sun/star/util/XNumberFormatsSupplier.idl>
+#endif
+
+//=============================================================================
+
+ module com {  module sun {  module star {  module report {
+
+//=============================================================================
+/** describes a control which can be used for displaying values with a arbitrary formatting.
+
+    @see com::sun::star::report::XReportControlModel
+    @see com::sun::star::util::XNumberFormatsSupplier
+*/
+interface XFormattedField
+{
+    interface XReportControlModel;
+
+    /** specifies the format to be used when formatting the field input
+        and output.
+
+        <p>This value is meaningful relative to the FormatsSupplier attribute
+        only.</p>
+     */
+    [attribute,bound] long FormatKey;
+
+    /** supplies the formats the field should work with.
+     */
+    [attribute,bound] com::sun::star::util::XNumberFormatsSupplier FormatsSupplier;
+};
+
+service FormattedField : XFormattedField;
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif
diff --git a/offapi/com/sun/star/report/XFunction.idl b/offapi/com/sun/star/report/XFunction.idl
new file mode 100644
index 000000000000..ea658c82f7a3
--- /dev/null
+++ b/offapi/com/sun/star/report/XFunction.idl
@@ -0,0 +1,98 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XFunction.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-07-06 07:20:31 $
+ *
+ *  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_XFunction_idl__
+#define __com_sun_star_report_XFunction_idl__
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+#ifndef __com_sun_star_beans_Optional_idl__
+#include <com/sun/star/beans/Optional.idl>
+#endif
+#ifndef __com_sun_star_lang_XComponent_idl__
+#include <com/sun/star/lang/XComponent.idl>
+#endif
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+//=============================================================================
+ module com {  module sun {  module star {  module report {
+//=============================================================================
+/** specifies a format condition for a control.
+*/
+interface XFunction
+{
+    /** gives access to the properties.
+    */
+    interface com::sun::star::beans::XPropertySet;
+
+    /** allows life-time control of function instances.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    /** allows the navigation to the functions object.
+        The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
+    */
+    interface com::sun::star::container::XChild;
+
+    /** specifies if the function should be evaluated before the report element will be executed.
+    */
+    [attribute,bound] boolean PreEvaluated;
+
+    /** specifies if sub reports should be traversed as well.
+    */
+    [attribute,bound] boolean DeepTraversing;
+
+    /** defines the name of the function
+    */
+    [attribute,bound] string Name;
+
+    /** defines the formular of this function
+    */
+    [attribute,bound] string Formula;
+
+    /** defines the formular for the intial value
+    */
+    [attribute,bound] com::sun::star::beans::Optional<string> InitialFormula;
+};
+
+service Function : XFunction
+{
+    create();
+};
+//=============================================================================
+
+}; }; }; };
+#endif