diff options
Diffstat (limited to 'offapi/com/sun/star/report')
35 files changed, 3867 insertions, 0 deletions
diff --git a/offapi/com/sun/star/report/Calculation.idl b/offapi/com/sun/star/report/Calculation.idl new file mode 100644 index 000000000000..228f7291c086 --- /dev/null +++ b/offapi/com/sun/star/report/Calculation.idl @@ -0,0 +1,136 @@ +/************************************************************************* + * + * 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_Calculation_idl__ +#define __com_sun_star_report_Calculation_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies how to calculate a value. + @see XFormattedField + */ +constants Calculation +{ + //------------------------------------------------------------------------- + + /** returns the average of a field. + */ + const short NONE = 0; + + /** returns the average of a field. + */ + const short AVERAGE = 1; + + /** returns the correlation of two fields. + */ + const short CORRELATION = 2; + + /** counts the number of values, from the field. + */ + const short COUNT = 3; + + /** returns the measure of the linear relation between paired variables. + */ + const short COVARIANCE = 4; + + /** returns the number of none repeating values, from the field. + */ + const short DISTINCTCOUNT = 5; + + /** returns the largest value from the field. + */ + const short MAXIMUM = 6; + + /** returns the middle value in a sequence of numeric values. + */ + const short MEDIAN = 7; + + /** returns the smallest value from the field. + */ + const short MINIMUM = 8; + + /** returns the most frequently returning value from the field. + */ + const short MODE = 9; + + /** returns the Nth largest value from the field. + */ + const short NTHLARGEST = 10; + + /** returns the Nth most commonly occurring value from the field. + */ + const short NTHMOSTFREQUENT = 11; + + /** returns the Nth smallest value from the field. + */ + const short NTHSMALLEST = 12; + + /** returns as a percentage of the grand total summary. + */ + const short PERCENTAGE = 13; + + /** returns the value for a specified percentile in a Number or Currency field. + */ + const short PERCENTILE = 14; + + /** returns how much each value in the field deviate from the mean or average value for that field. + */ + const short POPSTANDARDDEVIATION = 15; + + /** returns the square of the standard deviation. + */ + const short POPVARIANCE = 16; + + /** returns the sample standard deviation for the field. + */ + const short SAMPLESTANDARDDEVIATION = 17; + + /** returns the sample variance for the field. + */ + const short SAMPLEVARIANCE = 18; + + /** returns the total of all the values for the field. + */ + const short SUM = 19; + + /** returns the weighted average for the field. + */ + const short WEIGHTEDAVG = 20; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/ForceNewPage.idl b/offapi/com/sun/star/report/ForceNewPage.idl new file mode 100644 index 000000000000..38a15a56df9c --- /dev/null +++ b/offapi/com/sun/star/report/ForceNewPage.idl @@ -0,0 +1,69 @@ +/************************************************************************* + * + * 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_ForceNewPage_idl__ +#define __com_sun_star_report_ForceNewPage_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies if the section will be printed on an separte page. + <p>This does not apply to page header or page footer.</p> + @see XSection + */ +constants ForceNewPage +{ + //------------------------------------------------------------------------- + + /** The current section is printed on the current page. + */ + const short NONE = 0; + + /** The current section is printed at the top of a new page. + */ + const short BEFORE_SECTION = 1; + + /** The next section following the current section is printed at the top of a new page. + */ + const short AFTER_SECTION = 2; + + /** The current section is printed at the top of a new page as well as the next section. + */ + const short BEFORE_AFTER_SECTION = 3; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/GroupKeepTogether.idl b/offapi/com/sun/star/report/GroupKeepTogether.idl new file mode 100644 index 000000000000..8c3a7110c2e4 --- /dev/null +++ b/offapi/com/sun/star/report/GroupKeepTogether.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * 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_GroupKeepTogether_idl__ +#define __com_sun_star_report_GroupKeepTogether_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies if groups in a multi column report where the group has the property + <member scope="XGroup">KeepTogether</member> set to WHOLE_GROUP or WITH_FIRST_DETAIL will keep together by page or column. + @see XGroup + */ +constants GroupKeepTogether +{ + //------------------------------------------------------------------------- + + /** Groups are kept together by page. + */ + const short PER_PAGE = 0; + + /** Groups are kept together by column. + */ + const short PER_COLUMN = 1; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/GroupOn.idl b/offapi/com/sun/star/report/GroupOn.idl new file mode 100644 index 000000000000..e3959e8885c7 --- /dev/null +++ b/offapi/com/sun/star/report/GroupOn.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * 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_GroupOn_idl__ +#define __com_sun_star_report_GroupOn_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies how to group data. + @see XGroup + */ +constants GroupOn +{ + //------------------------------------------------------------------------- + + /** The same value in the column value or expression. + */ + const short DEFAULT = 0; + + /** The same first nth of characters in the column value or expression. + */ + const short PREFIX_CHARACTERS = 1; + + /** Dates in the same calendar year. + */ + const short YEAR= 2; + + /** Dates in the same calendar quarter. + */ + const short QUARTAL = 3; + + /** Dates in the same month. + */ + const short MONTH = 4; + + /** Dates in the same week. + */ + const short WEEK = 5; + + /** Dates on the same date. + */ + const short DAY = 6; + + /** Times in the same hour. + */ + const short HOUR = 7; + + /** Times in the same minute. + */ + const short MINUTE = 8; + + /** Values within an interval you specify. + */ + const short INTERVAL = 9; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/KeepTogether.idl b/offapi/com/sun/star/report/KeepTogether.idl new file mode 100644 index 000000000000..0a5ccbc70d26 --- /dev/null +++ b/offapi/com/sun/star/report/KeepTogether.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * + * 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_KeepTogether_idl__ +#define __com_sun_star_report_KeepTogether_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies that a group header, detail, and footer section is printed on the same page. + @see XGroup + */ +constants KeepTogether +{ + //------------------------------------------------------------------------- + + /** Prints the group without keeping the header, detail, and footer together on the same page. + */ + const short NO = 0; + + /** Prints the group header, detail, and footer together on the same page. + */ + const short WHOLE_GROUP = 1; + + /** Prints the group header on a page when the first detail record can fit on the same page. + */ + const short WITH_FIRST_DETAIL = 2; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/ReportPrintOption.idl b/offapi/com/sun/star/report/ReportPrintOption.idl new file mode 100644 index 000000000000..218944d2b513 --- /dev/null +++ b/offapi/com/sun/star/report/ReportPrintOption.idl @@ -0,0 +1,67 @@ +/************************************************************************* + * + * 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_ReportPrintOption_idl__ +#define __com_sun_star_report_ReportPrintOption_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies wether a page header or footer is printed on the same page as the report header or report footer. + */ +constants ReportPrintOption +{ + //------------------------------------------------------------------------- + + /** The page header/footer is printed on all pages. + */ + const short ALL_PAGES = 0; + + /** The page header/footer is not printed on the same page as the report header. + */ + const short NOT_WITH_REPORT_HEADER = 1; + + /** The page header/footer is not printed on the same page as the report footer. + */ + const short NOT_WITH_REPORT_FOOTER = 2; + + /** The page header/footer is not printed on the same page as the report header or footer. + */ + const short NOT_WITH_REPORT_HEADER_FOOTER = 3; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/SectionPageBreak.idl b/offapi/com/sun/star/report/SectionPageBreak.idl new file mode 100644 index 000000000000..04af47ae1609 --- /dev/null +++ b/offapi/com/sun/star/report/SectionPageBreak.idl @@ -0,0 +1,60 @@ +/************************************************************************* + * + * 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_SectionPageBreak_idl__ +#define __com_sun_star_report_SectionPageBreak_idl__ + + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= + +/** Specifies that page breaks are allowed inside this section. + @see XSection + */ +constants SectionPageBreak +{ + //------------------------------------------------------------------------- + + /** Page breaks will never be inserted. If the section doesn't fit on a page than the content will be cut. + */ + const short NONE = 0; + + /** If the section doesn't fit on page than a page break will be inserted as long as the section fits. Inner sections will doesn't contain further page breaks. + */ + const short SECTION = 1; + + /** If the section doesn't fit on page than a page break will be inserted as long as the section fits. + */ + const short AUTO = 2; +}; +//============================================================================= +}; }; }; }; +/*============================================================================= +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XFixedLine.idl b/offapi/com/sun/star/report/XFixedLine.idl new file mode 100644 index 000000000000..f1f44f5fcf1a --- /dev/null +++ b/offapi/com/sun/star/report/XFixedLine.idl @@ -0,0 +1,108 @@ +/************************************************************************* + * + * 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_XFixedLine_idl__ +#define __com_sun_star_report_XFixedLine_idl__ + +#ifndef __com_sun_star_report_XReportControlModel_idl__ +#include <com/sun/star/report/XReportControlModel.idl> +#endif +#ifndef __com_sun_star_drawing_CircleKind_idl__ +#include <com/sun/star/drawing/CircleKind.idl> +#endif +#ifndef __com_sun_star_drawing_LineStyle_idl__ +#include <com/sun/star/drawing/LineStyle.idl> +#endif + +#ifndef __com_sun_star_util_Color_idl__ +#include <com/sun/star/util/Color.idl> +#endif + +#ifndef __com_sun_star_drawing_LineDash_idl__ +#include <com/sun/star/drawing/LineDash.idl> +#endif +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= +interface XFixedLine +{ + interface XReportControlModel; + + /** specifies the orientation of the control. + + <pre> + 0: horizontal + 1: vertical </default> + </pre> + */ + [attribute,bound] long Orientation + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This property contains the type of the line. + */ + [attribute,bound] com::sun::star::drawing::LineStyle LineStyle; + + //------------------------------------------------------------------------- + + /** This property contains the dash of the line. + */ + [attribute,bound] com::sun::star::drawing::LineDash LineDash; + + //------------------------------------------------------------------------- + + /** This property contains the line color. + */ + [attribute,bound] com::sun::star::util::Color LineColor; + + //------------------------------------------------------------------------- + + /** This property contains the extent of transparency. + */ + [attribute,bound] short LineTransparence; + + //------------------------------------------------------------------------- + + /** This property contains the width of the line in 1/100th mm. + */ + [attribute,bound] long LineWidth; + + //------------------------------------------------------------------------- +}; + +service FixedLine : XFixedLine; +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XFixedText.idl b/offapi/com/sun/star/report/XFixedText.idl new file mode 100644 index 000000000000..8c10e1935548 --- /dev/null +++ b/offapi/com/sun/star/report/XFixedText.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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_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; +}; + +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..187c1b524af2 --- /dev/null +++ b/offapi/com/sun/star/report/XFormatCondition.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * 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_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..5de71ec50b64 --- /dev/null +++ b/offapi/com/sun/star/report/XFormattedField.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * 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_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..7f3ac1a136e3 --- /dev/null +++ b/offapi/com/sun/star/report/XFunction.idl @@ -0,0 +1,90 @@ +/************************************************************************* + * + * 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_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 diff --git a/offapi/com/sun/star/report/XFunctions.idl b/offapi/com/sun/star/report/XFunctions.idl new file mode 100644 index 000000000000..5a6ab1e8930f --- /dev/null +++ b/offapi/com/sun/star/report/XFunctions.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * 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_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 diff --git a/offapi/com/sun/star/report/XFunctionsSupplier.idl b/offapi/com/sun/star/report/XFunctionsSupplier.idl new file mode 100644 index 000000000000..d28c13f4dbdb --- /dev/null +++ b/offapi/com/sun/star/report/XFunctionsSupplier.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * + * 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_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 diff --git a/offapi/com/sun/star/report/XGroup.idl b/offapi/com/sun/star/report/XGroup.idl new file mode 100644 index 000000000000..469889ff6c7a --- /dev/null +++ b/offapi/com/sun/star/report/XGroup.idl @@ -0,0 +1,149 @@ +/************************************************************************* + * + * 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_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 diff --git a/offapi/com/sun/star/report/XGroups.idl b/offapi/com/sun/star/report/XGroups.idl new file mode 100644 index 000000000000..ee2324f10855 --- /dev/null +++ b/offapi/com/sun/star/report/XGroups.idl @@ -0,0 +1,83 @@ +/************************************************************************* + * + * 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_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 diff --git a/offapi/com/sun/star/report/XImageControl.idl b/offapi/com/sun/star/report/XImageControl.idl new file mode 100644 index 000000000000..48c18cb0b864 --- /dev/null +++ b/offapi/com/sun/star/report/XImageControl.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * 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_XImageControl_idl__ +#define __com_sun_star_report_XImageControl_idl__ + +#ifndef __com_sun_star_report_XReportControlModel_idl__ +#include <com/sun/star/report/XReportControlModel.idl> +#endif +#ifndef __com_sun_star_form_XImageProducerSupplier_idl__ +#include <com/sun/star/form/XImageProducerSupplier.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= +interface XImageControl +{ + interface XReportControlModel; + + /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. + + <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> + at this producer. Then they will be notified of any change in the image to be displayed.</p> + + <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> + property is changed, the model loads the specified image, and sets it as image source + at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all + <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with + the binary data of the image.<br/> + Usually, controls acting for an <type>ImageControl</type> model are consumers, and use the + data stream to display the image</p> + */ + interface com::sun::star::form::XImageProducerSupplier; + + /** specifies an URL to an image to use for the control. + */ + [attribute,bound] string ImageURL; + + /** defines how to scale the image + + <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p> + + <p>The value of this property is one of the <type scope="com::sun::star::awt">ImageScaleMode</type> constants.</p> + + @since OOo 3.2 + */ + [attribute,bound] short ScaleMode + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document. + If the data field contains something different as string then this attribute will be ignored. + */ + [attribute,bound] boolean PreserveIRI; +}; + +service ImageControl : XImageControl; +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif 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 diff --git a/offapi/com/sun/star/report/XReportControlFormat.idl b/offapi/com/sun/star/report/XReportControlFormat.idl new file mode 100644 index 000000000000..608b1e7aa5f4 --- /dev/null +++ b/offapi/com/sun/star/report/XReportControlFormat.idl @@ -0,0 +1,613 @@ +/************************************************************************* + * + * 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_XReportControlFormat_idl__ +#define __com_sun_star_report_XReportControlFormat_idl__ + +#include <com/sun/star/awt/FontDescriptor.idl> +#include <com/sun/star/awt/FontSlant.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/lang/Locale.idl> +#include <com/sun/star/style/ParagraphAdjust.idl> +#include <com/sun/star/style/VerticalAlignment.idl> +#include <com/sun/star/util/Color.idl> +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= +/** specifies a format condition for a control. +*/ +interface XReportControlFormat +{ + /** specifies the background color (RGB) of the control. + */ + [attribute,bound] com::sun::star::util::Color ControlBackground + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** determines if the back ground color is set to transparent. + */ + [attribute,bound] boolean ControlBackgroundTransparent + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the horizontal alignment of the text. + @see ::com::sun::star::style::ParagraphAdjust + */ + [attribute,bound] short ParaAdjust + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the font attributes of the text in the control. + */ + [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptor + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the font attributes of the text in the control. + */ + [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptorAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the font attributes of the text in the control. + */ + [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptorComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. + */ + [attribute,bound] short ControlTextEmphasis + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** contains the font emphasis value as <type scope="com::sun::star::text">FontEmphasis</type>. + */ + [attribute,bound] short CharEmphasis + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** determins whether text is formatted in two lines. + <p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p> + */ + [attribute,bound] boolean CharCombineIsOn + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** contains the prefix (usually parenthesis) before text that is formatted in two lines. + <p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p> + */ + [attribute,bound] string CharCombinePrefix + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** contains the suffix (usually parenthesis) after text that is formatted in two lines. + <p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p> + */ + [attribute,bound] string CharCombineSuffix + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** If this optional property is <TRUE/>, then the characters are invisible. + + @since OOo 2.0.0 + */ + [attribute,bound] boolean CharHidden + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** specifies if the characters are formatted and + displayed with a shadow effect. + */ + [attribute,bound] boolean CharShadowed + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies if the characters are formatted and + displayed with a contour effect. + */ + [attribute,bound] boolean CharContoured + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** optional property which contains the value of the case-mapping of the + text for formatting and displaying. + + @see CaseMap + */ + [attribute,bound] short CharCaseMap + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** contains the value of the locale. + */ + [attribute,bound] com::sun::star::lang::Locale CharLocale + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the percentage of raisement/lowerment of superscript/subscript + characters. + + <p>Negative values denote subscripts and positive values superscripts.</p> + */ + [attribute,bound] short CharEscapement + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This is the additional height used for subscript or superscript + characters in units of percent. + For subscript characters the value is negative and for + superscript characters positive. + */ + [attribute,bound] byte CharEscapementHeight + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** optional property to determine whether the kerning tables from the current font are used. + <p>Automatic <em>kerning</em> applies a spacing in between certain + pairs of characters to make the text look better.</p> + */ + [attribute,bound] boolean CharAutoKerning + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** optional property which contains the value of the kerning of the characters. + */ + [attribute,bound] short CharKerning + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** If this optional property is <TRUE/>, then the characters are flashing. + */ + [attribute,bound] boolean CharFlash + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [attribute,bound] short CharRelief + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This attribute specifies the name of the font style. + + + + <p>It may contain more than one name separated by comma.</p> + */ + [attribute,bound] string CharFontName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains the name of the font style. + + <p>This attribute may be empty.</p> + */ + [attribute,bound] string CharFontStyleName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains font family as specified in + com.sun.star.awt.FontFamily . + */ + [attribute,bound] short CharFontFamily + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains the text encoding of the font as specified in + com.sun.star.awt.CharSet. + */ + [attribute,bound] short CharFontCharSet + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch. + */ + [attribute,bound] short CharFontPitch + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the text color (RGB) of the control. + */ + [attribute,bound] com::sun::star::util::Color CharColor + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** specifies the text line color (RGB) of the control. + */ + [attribute,bound] com::sun::star::util::Color CharUnderlineColor + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** This value contains the height of the characters in point. + */ + [attribute,bound] float CharHeight + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** This attribute contains the value for the character underline.@see com::sun::star::awt::FontUnderline + */ + [attribute,bound] short CharUnderline + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** This attribute contains the value of the font weight.@see com::sun::star::awt::FontWeight + */ + [attribute,bound] float CharWeight + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + + /** This attribute contains the value of the posture of the document.@see com::sun::star::awt::FontSlant + */ + [attribute,bound] com::sun::star::awt::FontSlant CharPosture + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** determins the type of the strike out of the character. + @see com.sun.star.awt.FontStrikeout + */ + [attribute,bound] short CharStrikeout + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** If this attribute is <TRUE/>, the underline and strike-through + properties are not applied to white spaces. + */ + [attribute,bound] boolean CharWordMode + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** determins the rotation of a character in degree. + <p>Depending on the implementation only certain values may be allowed. + </p> + */ + [attribute,bound] short CharRotation + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + + /** determins the percentage value for scaling the width of characters. + + <p>The value refers to the original width which is denoted by 100, + and it has to be greater than 0.</p> + + */ + [attribute,bound] short CharScaleWidth + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** specifies the vertical alignment of the text in the control. + @see com::sun::star::style::VerticalAlignment + */ + [attribute,bound] com::sun::star::style::VerticalAlignment VerticalAlign + { + set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the URL of a hyperlink (if set). + */ + [attribute,bound] string HyperLinkURL + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the name of the target for a hyperlink (if set). + */ + [attribute,bound] string HyperLinkTarget + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the name of the hyperlink (if set). + */ + [attribute,bound] string HyperLinkName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //-------------------------------------------------------------------- + /** contains the character style name for visited hyperlinks. + */ + [attribute,bound] string VisitedCharStyleName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //-------------------------------------------------------------------- + /** contains the character style name for unvisited hyperlinks. + */ + [attribute,bound] string UnvisitedCharStyleName + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + /** This value contains the height of the characters in point. + */ + [attribute,bound] float CharHeightAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight + */ + [attribute,bound] float CharWeightAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property specifies the name of the font style. + <p>It may contain more than one name separated by comma.</p> + */ + [attribute,bound] string CharFontNameAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the name of the font style. + <p>This property may be empty.</p> + */ + [attribute,bound] string CharFontStyleNameAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains font family as specified in + com.sun.star.awt.FontFamily . + */ + [attribute,bound] short CharFontFamilyAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the text encoding of the font as specified in + com.sun.star.awt.CharSet. + */ + [attribute,bound] short CharFontCharSetAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the font pitch as specified in com.sun.star.awt.FontPitch. + */ + [attribute,bound] short CharFontPitchAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant + */ + [attribute,bound] com::sun::star::awt::FontSlant CharPostureAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the value of the locale. + */ + [attribute,bound] com::sun::star::lang::Locale CharLocaleAsian + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** This value contains the height of the characters in point. + */ + [attribute,bound] float CharHeightComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight + */ + [attribute,bound] float CharWeightComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property specifies the name of the font style. + <p>It may contain more than one name separated by comma.</p> + */ + [attribute,bound] string CharFontNameComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the name of the font style. + <p>This property may be empty.</p> + */ + [attribute,bound] string CharFontStyleNameComplex + + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains font family as specified in + com.sun.star.awt.FontFamily . + */ + [attribute,bound] short CharFontFamilyComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the text encoding of the font as specified in + com.sun.star.awt.CharSet. + */ + [attribute,bound] short CharFontCharSetComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the font pitch as specified in com.sun.star.awt.FontPitch. + */ + [attribute,bound] short CharFontPitchComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + //------------------------------------------------------------------------- + /** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant + */ + [attribute,bound] com::sun::star::awt::FontSlant CharPostureComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + //------------------------------------------------------------------------- + /** contains the value of the locale. + */ + [attribute,bound] com::sun::star::lang::Locale CharLocaleComplex + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; +}; + +service ReportControlFormat : XReportControlFormat; +//============================================================================= + +}; }; }; }; +#endif diff --git a/offapi/com/sun/star/report/XReportControlModel.idl b/offapi/com/sun/star/report/XReportControlModel.idl new file mode 100644 index 000000000000..2c28f5fcc570 --- /dev/null +++ b/offapi/com/sun/star/report/XReportControlModel.idl @@ -0,0 +1,115 @@ +/************************************************************************* + * + * 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_XReportControlModel_idl__ +#define __com_sun_star_report_XReportControlModel_idl__ + +#ifndef __com_sun_star_report_XReportComponent_idl__ +#include <com/sun/star/report/XReportComponent.idl> +#endif +#ifndef __com_sun_star_report_XReportControlFormat_idl__ +#include <com/sun/star/report/XReportControlFormat.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_report_XFormatCondition_idl__ +#include <com/sun/star/report/XFormatCondition.idl> +#endif +//============================================================================= + + module com { module sun { module star { module report { + +//============================================================================= +interface XReportControlModel +{ + /** allows the creation of sub reports. + */ + interface XReportComponent; + + interface XReportControlFormat; + + /** allows to register listeners to be notified of changes in the container. + */ + interface com::sun::star::container::XContainer; + + /** gives access to the <type scope="com::sun::star::report">XFormatCondition</type> elements by index. + */ + interface com::sun::star::container::XIndexContainer; + + /** Creates a format condition. + @return + report component + */ + XFormatCondition createFormatCondition() raises( com::sun::star::uno::Exception ); + + + /** Specifies which content should be shown. + The value can be <br/> + <li>the name of a database column. The format to use is field:[name] </li> + <li>the name of a function defined in the report or a group. The format to use is rpt:[functionName]</li> + <li>an expression like rpt:24+24-47</li> + @see http://wiki.services.openoffice.org/wiki/SUN_Report_Builder + @see http://wiki.services.openoffice.org/wiki/SUN_Report_Builder#Syntax + @see http://wiki.services.openoffice.org/wiki/Base/Reports/Functions + */ + [attribute,bound] string DataField + { + set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** Specifies that the element gets printed when the group changes. + The default value is <FALSE/>. + */ + [attribute,bound] boolean PrintWhenGroupChange + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; + + /** Describes the print expression of the report control model. + If the expression evaluates to true than the report control model will be printed otherwise not. + */ + [attribute,bound] string ConditionalPrintExpression + { + set raises ( com::sun::star::beans::UnknownPropertyException ); + get raises ( com::sun::star::beans::UnknownPropertyException ); + }; +}; + +service ReportControlModel : XReportControlModel; +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XReportDefinition.idl b/offapi/com/sun/star/report/XReportDefinition.idl new file mode 100644 index 000000000000..9af58a8d702e --- /dev/null +++ b/offapi/com/sun/star/report/XReportDefinition.idl @@ -0,0 +1,362 @@ +/************************************************************************* + * + * 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_XReportDefinition_idl__ +#define __com_sun_star_report_XReportDefinition_idl__ + +#ifndef __com_sun_star_report_XReportComponent_idl__ +#include <com/sun/star/report/XReportComponent.idl> +#endif +#ifndef __com_sun_star_report_XFunctionsSupplier_idl__ +#include <com/sun/star/report/XFunctionsSupplier.idl> +#endif +#ifndef __com_sun_star_view_PaperOrientation_idl__ +#include <com/sun/star/view/PaperOrientation.idl> +#endif +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif +#ifndef __com_sun_star_style_GraphicLocation_idl__ +#include <com/sun/star/style/GraphicLocation.idl> +#endif +#ifndef __com_sun_star_view_PaperFormat_idl__ +#include <com/sun/star/view/PaperFormat.idl> +#endif +#ifndef __com_sun_star_util_XClosable_idl__ +#include <com/sun/star/util/XCloseable.idl> +#endif +#ifndef __com_sun_star_ui_XUIConfigurationManagerSupplier_idl__ +#include <com/sun/star/ui/XUIConfigurationManagerSupplier.idl> +#endif +#ifndef __com_sun_star_document_XDocumentSubStorageSupplier_idl__ +#include <com/sun/star/document/XDocumentSubStorageSupplier.idl> +#endif +#ifndef __com_sun_star_frame_XModel_idl__ +#include <com/sun/star/frame/XModel.idl> +#endif +#ifndef __com_sun_star_document_XViewDataSupplier_idl__ +#include <com/sun/star/document/XViewDataSupplier.idl> +#endif +#ifndef __com_sun_star_frame_XLoadable_idl__ +#include <com/sun/star/frame/XLoadable.idl> +#endif +#ifndef __com_sun_star_embed_XVisualObject_idl__ +#include <com/sun/star/embed/XVisualObject.idl> +#endif +#ifndef __com_sun_star_embed_XStorageBasedDocument_idl__ +#include <com/sun/star/document/XStorageBasedDocument.idl> +#endif +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif +#ifndef __com_sun_star_util_XModifiable2_idl__ +#include <com/sun/star/util/XModifiable2.idl> +#endif +#ifndef __com_sun_star_document_XEventBroadcaster_idl__ +#include <com/sun/star/document/XEventBroadcaster.idl> +#endif +#ifndef __com_sun_star_lang_DisposedException_idl__ +#include <com/sun/star/lang/DisposedException.idl> +#endif +#ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__ +#include <com/sun/star/style/XStyleFamiliesSupplier.idl> +#endif + +module com { module sun { module star { module sdbc { +published interface XConnection; +};};};}; +//============================================================================= + + module com { module sun { module star { module report { + + interface XSection; + interface XGroups; +//============================================================================= + +/** identifies a <type>XReportComponent</type> as being a (sub-) report. + + <p>This interface does not really provide an own functionality, it is only for easier + runtime identification of report components.</p> + + <p>A report fulfills several tasks, like storing the structure of its + report components and it provides the + event environment for its contained elements.</p> + + @see XReportComponent + */ +interface XReportDefinition +{ + /** allows the access to the model embedded in the database storage. + */ + interface com::sun::star::frame::XModel; + + /** offers a simple way to initialize a component. + */ + interface com::sun::star::frame::XLoadable; + + /** represents common visualisation functionality for the embedded report. + */ + interface com::sun::star::embed::XVisualObject; + + /** allows to initialize the document with a storage. + */ + interface com::sun::star::document::XStorageBasedDocument; + + /** gives access to some properties describing all open views to a document. + */ + interface com::sun::star::document::XViewDataSupplier; + + /** allows to close the document. + */ + interface com::sun::star::util::XCloseable; + + /** allows to retrieve the user interface configuration manager related to an object. + */ + interface com::sun::star::ui::XUIConfigurationManagerSupplier; + + interface com::sun::star::document::XDocumentSubStorageSupplier; + + /** provides access to the collection of style families. + + <p>A spreadsheet document contains 2 families of styles: + "PageStyles" and "CellStyles".</p> + */ + interface com::sun::star::style::XStyleFamiliesSupplier; + + //------------------------------------------------------------------------- + /** a storable document should provide information about his modify state + + <p> + With this interface it's possible too, to reset the modify state. + That can be neccessary to prevent code against problem during closing + of the document without saving any changes. + </p> + */ + interface com::sun::star::util::XModifiable2; + + /** allows the creation of sub reports. + */ + interface XReportComponent; + + /** gives access to functions defined in the report definition. + */ + interface XFunctionsSupplier; + + /** makes it possible to register listeners which are called whenever + a document event occurs. + This is a workaround due to the fact that this interface can not be directly inherited from <type scope="com::sun::star::document">XEventBroadcaster</type> + because the methods addEventListener and removeEventListener are already defined in <type scope="com::sun::star::lang">XComponent</type>. + A queryInterface call is still supported to the <type scope="com::sun::star::document">XEventBroadcaster</type> interface. + */ + com::sun::star::document::XEventBroadcaster getEventBroadcaster() + raises( ::com::sun::star::lang::DisposedException, + ::com::sun::star::uno::Exception ); + + /** returns a sequence of the currently supported output formats. + */ + sequence<string> getAvailableMimeTypes() + raises( ::com::sun::star::lang::DisposedException, + ::com::sun::star::uno::Exception ); + + //------------------------------------------------------------------------- + + /** Represents the output format (media (mime) type) of the resulting document when executing this report. + */ + [attribute,bound] string MimeType + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** Represents the title of the report in print preview. + */ + [attribute,bound] string Caption; + + /** Specifies whether groups in a multi column report are kept together. + @see com.sun.star.report.GroupKeepTogether + */ + [attribute,bound] short GroupKeepTogether + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** Represents the location of the page header. + @see ReportPrintOption + */ + [attribute,bound] short PageHeaderOption; + + /** Represents the location of the page footer. + @see ReportPrintOption + */ + [attribute,bound] short PageFooterOption; + + + /** is the command which should be executed, the type of command depends + on the CommandType. + <p>In case of a <member>CommandType</member> of <member>CommandType::COMMAND</member>, + means in case the <member>Command</member> specifies an SQL statement, the inherited + <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> + becomes relevant:<br/> + It then can be to used to specify whether the SQL statement should be analyzed on the + client side before sending it to the database server.<br/> + The default value for <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> + is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements, + which are not standard SQL, to your database.</p> + + + @see com::sun::star::sdb::CommandType + */ + [attribute,bound] string Command; + + /** specifies the type of the command to be executed to retrieve a result set. + + <p><member>Command</member> needs to be interpreted depending on the value of this property.</p> + + <p>This property is only meaningfull together with the <member>Command</member> + property, thus either <em>both</em> or <em>none</em> of them are present.</p> + + @see com::sun::star::sdb::CommandType + */ + [attribute,bound] long CommandType; + + /** specifies an addtional filter to optinally use. + + <p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p> + + <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member> + are specified, a <type>RowSet</type> can be created with this information. If the results provided by the + row set are to be additionally filtered, the Filter property can be used.</p> + + <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified + in the DataAccessDescriptor.</p> + + @see com::sun::star::sdb::RowSet + @see ResultSet + */ + [attribute,bound] string Filter; + + /** specifies if the <member>Command</member> should be analyzed on the client side before sending it + to the database server. + + <p>The default value of this property is <TRUE/>. By switching it to <FALSE/>, you can pass + backend-specific SQL statements, which are not standard SQL, to your database.</p> + + <p>This property is usually present together with the <member>Command</member> and + <member>CommandType</member> properties, and is evaluated if and only if <member>CommandType</member> + equals <member>CommandType::COMMAND</member>.</p> + */ + [attribute,bound] boolean EscapeProcessing; + + /** specifies the active connection which is used to create the resulting report. + */ + [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** is the name of the datasource to use, this could be a named datasource + or the URL of a data access component. + */ + [attribute,bound] string DataSourceName; + + /** Defines that the report header is on. + Default is <FALSE/>. + */ + [attribute,bound] boolean ReportHeaderOn; + + /** Defines that the report footer is on. + Default is <FALSE/>. + */ + [attribute,bound] boolean ReportFooterOn; + + /** Defines that the page header is on. + Default is <TRUE/>. + */ + [attribute,bound] boolean PageHeaderOn; + + /** Defines that the page footer is on. + Default is <TRUE/>. + */ + [attribute,bound] boolean PageFooterOn; + + /** Represents the groups of the report. + */ + [attribute,readonly] com::sun::star::report::XGroups Groups; + + /** returns the report header if the <member>ReportHeaderOn</member>is <TRUE/>. + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + If the report has the report header disabled. + @see XSection + */ + [attribute,readonly] com::sun::star::report::XSection ReportHeader + { + get raises (com::sun::star::container::NoSuchElementException); + }; + + /** returns the page header if the <member>PageHeaderOn</member>is <TRUE/>. + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + If the report has the page header disabled. + @see XSection + */ + [attribute,readonly] com::sun::star::report::XSection PageHeader + { + get raises (com::sun::star::container::NoSuchElementException); + }; + + /** returns the detail section. + @see XSection + */ + [attribute,readonly] com::sun::star::report::XSection Detail; + + /** returns the page footer if the <member>PageFooterOn</member>is <TRUE/>. + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + If the report has the page footer disabled. + @see XSection + */ + [attribute,readonly] com::sun::star::report::XSection PageFooter + { + get raises (com::sun::star::container::NoSuchElementException); + }; + + /** returns the report footer if the <member>ReportFooterOn</member>is <TRUE/>. + @throws <type scope="com::sun::star::container">NullPointerException</type> + If the report has the report footer disabled. + @see XSection + */ + [attribute,readonly] com::sun::star::report::XSection ReportFooter + { + get raises (com::sun::star::container::NoSuchElementException); + }; +}; + +service ReportDefinition : XReportDefinition; +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XReportEngine.idl b/offapi/com/sun/star/report/XReportEngine.idl new file mode 100644 index 000000000000..7a154483ff20 --- /dev/null +++ b/offapi/com/sun/star/report/XReportEngine.idl @@ -0,0 +1,169 @@ +/************************************************************************* + * + * 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_XReportEngine_idl__ +#define __com_sun_star_report_XReportEngine_idl__ + +#ifndef __com_sun_star_report_XReportDefinition_idl__ +#include <com/sun/star/report/XReportDefinition.idl> +#endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_util_URL_idl__ +#include <com/sun/star/util/URL.idl> +#endif +#ifndef __com_sun_star_frame_XModel_idl__ +#include <com/sun/star/frame/XModel.idl> +#endif +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#include <com/sun/star/task/XStatusIndicator.idl> +#endif +#ifndef __com_sun_star_frame_XFrame_idl__ +#include <com/sun/star/frame/XFrame.idl> +#endif +#ifndef __com_sun_star_sdbc_XConnection_idl__ +#include <com/sun/star/sdbc/XConnection.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif +#ifndef __com_sun_star_lang_DisposedException_idl__ +#include <com/sun/star/lang/DisposedException.idl> +#endif +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= +module com { module sun { module star { module report { +/** identifies a <type>XReportEngine</type> which allows the creation of OpenDocument files. + + <p>The following events are supported by the report engine. + OnPageStarted Is fired when a new page started. + OnReportStarted Is fired when a new report started. + OnGroupStarted Is fired when a new group started. + OnGroupEnded Is fired when the group ended. + OnReportEnded Is fired when the report ended. + OnPageEnded Is fired when the page ended. + + @see com.sun.star.document.OfficeDocument +*/ + +interface XReportEngine +{ + /** allows life-time control of report engine. + */ + interface com::sun::star::lang::XComponent; + + /** gives access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + /** creates a report document. + @throws <type scope="com::sun::star::lang">DisposedException</type> + If the report engine is already disposed. + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> + If the report definition was not set or is <NULL/>. + */ + com::sun::star::frame::XModel createDocumentModel() + raises( ::com::sun::star::lang::DisposedException, + com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::uno::Exception ); + + /** creates a report document. + @param _frame + The frame must have a controller set. This controller will be set at the model. + @throws <type scope="com::sun::star::lang">DisposedException</type> + If the report engine is already disposed. + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> + If the report definition was not set or is <NULL/>. + + OJ: Has to be discussed if this method is usefull. + */ + com::sun::star::frame::XModel createDocumentAlive([in] com::sun::star::frame::XFrame frame) + raises( ::com::sun::star::lang::DisposedException, + com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::uno::Exception ); + + /** creates a report document. + @return + The URL where the new document is located. + @throws <type scope="com::sun::star::lang">DisposedException</type> + If the report engine is already disposed. + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> + If the report definition was not set or is <NULL/>. + */ + com::sun::star::util::URL createDocument() + raises( ::com::sun::star::lang::DisposedException, + com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::uno::Exception ); + + /** allows to interrupt the creation process of the report document. + @throws <type scope="com::sun::star::lang">DisposedException</type> + If the report engine is already disposed. + */ + void interrupt() + raises( ::com::sun::star::lang::DisposedException, + ::com::sun::star::uno::Exception ); + + /** specifies the report definition object which is used to create the resulting report. + */ + [attribute,bound] XReportDefinition ReportDefinition + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** specifies the active connection which is used to create the resulting report. + */ + [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** specifies the status indicator which shows the progress of the report generation process. + */ + [attribute] com::sun::star::task::XStatusIndicator StatusIndicator; + + /** defines the maximum number of rows which should be fetched for the report. + If the limit is exceeded, the excess rows are silently dropped. + <br/> + There is no limitation, if set to zero. + */ + [attribute,bound] long MaxRows; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/XSection.idl b/offapi/com/sun/star/report/XSection.idl new file mode 100644 index 000000000000..294bd449c6cc --- /dev/null +++ b/offapi/com/sun/star/report/XSection.idl @@ -0,0 +1,195 @@ +/************************************************************************* + * + * 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_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..50e366fc2a79 --- /dev/null +++ b/offapi/com/sun/star/report/XShape.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * 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_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; + + /** determines if the object is opaque or transparent for text. + */ + [attribute,bound] boolean Opaque; +}; + +service Shape : XShape; +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/report/inspection/DataProviderHandler.idl b/offapi/com/sun/star/report/inspection/DataProviderHandler.idl new file mode 100644 index 000000000000..a7348b5aca9d --- /dev/null +++ b/offapi/com/sun/star/report/inspection/DataProviderHandler.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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_inspection_DataProviderHandler_idl__ +#define __com_sun_star_report_inspection_DataProviderHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module report { module inspection { + +//============================================================================= + +/** implements the default property handler for all known types of <type scope="com::sun::star::chart2::data">XDataProvider</type>s. + + @see com::sun::star::inspection::XPropertyHandler +*/ +service DataProviderHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl b/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl new file mode 100644 index 000000000000..842dd8d3b047 --- /dev/null +++ b/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * 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_inspection__DefaultComponentInspectorModel_idl__ +#define __com_sun_star_report_inspection_DefaultComponentInspectorModel_idl__ + +#ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__ +#include <com/sun/star/inspection/XObjectInspectorModel.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module report { module inspection { + +//============================================================================= + +/** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for + inspecting form components, in particular all components implementing the <type>ReportComponent</type> + service. + + <p>A <type>DefaultComponentInspectorModel</type> provides the following handlers by default: + <ul><li><type>GeometryHandler</type></li> + <li><type>ReportComponentHandler</type></li> + <li><typescope="com::sun::star::form::inspection">EditPropertyHandler</type></li> + </ul></p> + + @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories +*/ +service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel +{ + /** creates a default DefaultComponentInspectorModel, providing factories for all + handlers listed above. + + @since OOo 2.2 + */ + createDefault(); + + /** creates a default DefaultComponentInspectorModel, providing factories for all + handlers listed above, and describing an ObjectInspector which has a help section. + + @param minHelpTextLines + denotes the minimum number of lines of text to be reserved for the help + section. + + @param maxHelpTextLines + denotes the maximum number of lines of text to be reserved for the help + section. + + @throws ::com::sun::star::lang::IllegalArgumentException + if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative, + or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>. + + @see XObjectInspectorModel::HasHelpSection + @see XObjectInspectorModel::MinHelpTextLines + @see XObjectInspectorModel::MaxHelpTextLines + + @since OOo 2.2 + */ + createWithHelpSection( + [in] long minHelpTextLines, + [in] long maxHelpTextLines + ) + raises ( ::com::sun::star::lang::IllegalArgumentException ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/report/inspection/ReportComponentHandler.idl b/offapi/com/sun/star/report/inspection/ReportComponentHandler.idl new file mode 100644 index 000000000000..132cbab1eccb --- /dev/null +++ b/offapi/com/sun/star/report/inspection/ReportComponentHandler.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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_inspection_ReportComponentHandler_idl__ +#define __com_sun_star_report_inspection_ReportComponentHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module report { module inspection { + +//============================================================================= + +/** implements the default property handler for all known types of <type scope="com::sun::star::report">XReportComponent</type>s. + + @see com::sun::star::inspection::XPropertyHandler +*/ +service ReportComponentHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/report/inspection/makefile.mk b/offapi/com/sun/star/report/inspection/makefile.mk new file mode 100644 index 000000000000..a123a2a42957 --- /dev/null +++ b/offapi/com/sun/star/report/inspection/makefile.mk @@ -0,0 +1,49 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssrptins +PACKAGE=com$/sun$/star$/report$/inspection + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + DefaultComponentInspectorModel.idl \ + ReportComponentHandler.idl \ + DataProviderHandler.idl + + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/report/makefile.mk b/offapi/com/sun/star/report/makefile.mk new file mode 100644 index 000000000000..c2fa45637555 --- /dev/null +++ b/offapi/com/sun/star/report/makefile.mk @@ -0,0 +1,69 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssreport +PACKAGE=com$/sun$/star$/report + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + modules.idl\ + XReportDefinition.idl \ + XReportComponent.idl \ + XReportControlModel.idl \ + XGroups.idl \ + XGroup.idl \ + XFormattedField.idl \ + XFixedText.idl \ + XImageControl.idl \ + XSection.idl \ + ReportPrintOption.idl \ + GroupKeepTogether.idl \ + ForceNewPage.idl \ + KeepTogether.idl \ + XReportEngine.idl \ + XFormatCondition.idl \ + XReportControlFormat.idl \ + XFunction.idl \ + XFunctions.idl \ + XFunctionsSupplier.idl \ + GroupOn.idl \ + XShape.idl \ + XFixedLine.idl + + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/report/meta/XFormulaParser.idl b/offapi/com/sun/star/report/meta/XFormulaParser.idl new file mode 100644 index 000000000000..96ae63f4c5e8 --- /dev/null +++ b/offapi/com/sun/star/report/meta/XFormulaParser.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * 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_meta_XFormulaParser_idl__ +#define __com_sun_star_report_meta_XFormulaParser_idl__ + +#include <com/sun/star/lang/XComponent.idl> +#include <com/sun/star/lang/DisposedException.idl> +#include <com/sun/star/sheet/XFormulaParser.idl> +#include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl> +#include <com/sun/star/sheet/XFormulaOpCodeMapper.idl> +#include <com/sun/star/beans/XPropertySet.idl> +//============================================================================= +module com { module sun { module star { module report { module meta { +/** identifies a <type>XFormulaParser</type> which allows to retrieve the meta data of all supported functions. + +*/ +interface XFormulaParser +{ + /** allows life-time control of report engine. + */ + interface com::sun::star::lang::XComponent; + + interface com::sun::star::sheet::XFormulaParser; + + /** gives access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + /** The complete mapping of Names to OpCodes. + + Names and symbols not defined here lead to a parser/print error. + */ + [attribute] sequence< sheet::FormulaOpCodeMapEntry > OpCodeMap; + + /** return the mapper for op codes. + */ + [attribute,readonly] com::sun::star::sheet::XFormulaOpCodeMapper FormulaOpCodeMapper; +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + +=============================================================================*/ + +#endif diff --git a/offapi/com/sun/star/report/meta/XFunctionCategory.idl b/offapi/com/sun/star/report/meta/XFunctionCategory.idl new file mode 100644 index 000000000000..9cb669c84573 --- /dev/null +++ b/offapi/com/sun/star/report/meta/XFunctionCategory.idl @@ -0,0 +1,76 @@ +/************************************************************************* + * + * 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_meta_XFunctionCategory_idl__ +#define __com_sun_star_report_meta_XFunctionCategory_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/lang/DisposedException.idl> +#include <com/sun/star/beans/XPropertySet.idl> + +//============================================================================= +module com { module sun { module star { module report { module meta { + +interface XFunctionDescription; +/** identifies a <type>XFunctionCategory</type> which allows to retrieve the meta data of all supported functions. + +*/ + +interface XFunctionCategory +{ + /** gives access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + /** gives access to all categories + */ + interface com::sun::star::container::XIndexAccess; + + /** same as getByIndex. + @see com.ssun.star.container.XIndexAccess + */ + XFunctionDescription getFunction([in] long position) + raises( com::sun::star::lang::IndexOutOfBoundsException, + com::sun::star::lang::WrappedTargetException ); + + /** returns the localized category's name. + */ + [attribute,readonly] string Name; + + /** specifies the category number. + */ + [attribute,readonly] long Number; +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + +=============================================================================*/ + +#endif diff --git a/offapi/com/sun/star/report/meta/XFunctionDescription.idl b/offapi/com/sun/star/report/meta/XFunctionDescription.idl new file mode 100644 index 000000000000..9ed060bcaa85 --- /dev/null +++ b/offapi/com/sun/star/report/meta/XFunctionDescription.idl @@ -0,0 +1,87 @@ +/************************************************************************* + * + * 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_meta_XFunctionDescription_idl__ +#define __com_sun_star_report_meta_XFunctionDescription_idl__ + +#include <com/sun/star/lang/DisposedException.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/sheet/FunctionArgument.idl> +//============================================================================= +module com { module sun { module star { module report { module meta { + +interface XFunctionCategory; + +/** identifies a <type>XFunctionDescription</type> which allows to retrieve the meta data of all supported functions. + +*/ +interface XFunctionDescription +{ + /** gives access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + string createFormula([in] sequence< string > arguments ) + raises( ::com::sun::star::lang::DisposedException, + com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::uno::Exception ); + + /** specifies the category number. + */ + [attribute,readonly] XFunctionCategory Category; + + /** returns the localized function's name. + */ + [attribute,readonly] string Name; + + //------------------------------------------------------------------------- + + /** returns a localized description of the function. + */ + [attribute,readonly] string Description; + + /** returns the signature of the function. + */ + [attribute,readonly] string Signature; + + //------------------------------------------------------------------------- + + /** returns a sequence of localized descriptions of the function's + arguments (in the order specified by the function). + */ + [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments; +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + +=============================================================================*/ + +#endif diff --git a/offapi/com/sun/star/report/meta/XFunctionManager.idl b/offapi/com/sun/star/report/meta/XFunctionManager.idl new file mode 100644 index 000000000000..a862ad07dd59 --- /dev/null +++ b/offapi/com/sun/star/report/meta/XFunctionManager.idl @@ -0,0 +1,74 @@ +/************************************************************************* + * + * 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_meta_XFunctionManager_idl__ +#define __com_sun_star_report_meta_XFunctionManager_idl__ + +#include <com/sun/star/lang/XComponent.idl> +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/container/NoSuchElementException.idl> +#include <com/sun/star/lang/DisposedException.idl> +#include <com/sun/star/report/meta/XFunctionCategory.idl> +#include <com/sun/star/report/meta/XFunctionDescription.idl> + +//============================================================================= +module com { module sun { module star { module report { module meta { +/** identifies a <type>XFunctionManager</type> which allows to retrieve the meta data of all supported functions. + +*/ +interface XFunctionManager +{ + /** allows life-time control of report engine. + */ + interface com::sun::star::lang::XComponent; + /** gives access to all categories + */ + interface com::sun::star::container::XIndexAccess; + + /** same as getByIndex. + @param position The postion. + @see com.ssun.star.container.XIndexAccess + */ + XFunctionCategory getCategory([in] long position) + raises( com::sun::star::lang::IndexOutOfBoundsException, + com::sun::star::lang::WrappedTargetException ); + + /** get the function description by name + @param name the name of the function + */ + XFunctionDescription getFunctionByName([in] string name) + raises( com::sun::star::container::NoSuchElementException); +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + +=============================================================================*/ + +#endif diff --git a/offapi/com/sun/star/report/meta/makefile.mk b/offapi/com/sun/star/report/meta/makefile.mk new file mode 100644 index 000000000000..2a6a6e7e79e1 --- /dev/null +++ b/offapi/com/sun/star/report/meta/makefile.mk @@ -0,0 +1,49 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssrptmeta +PACKAGE=com$/sun$/star$/report$/meta + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + XFunctionManager.idl \ + XFunctionCategory.idl \ + XFunctionDescription.idl \ + XFormulaParser.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/report/modules.idl b/offapi/com/sun/star/report/modules.idl new file mode 100644 index 000000000000..b9c4c7f0c03d --- /dev/null +++ b/offapi/com/sun/star/report/modules.idl @@ -0,0 +1,45 @@ +/************************************************************************* + * + * 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_modules_report_idl__ +#define __com_sun_star_modules_report_idl__ + +module com { module sun { module star { module report { + + /** collects services for inspecting report/components + @see com::sun::star::inspection::ObjectInspector + @see com::sun::star::inspection + */ + module inspection { }; + + /** collects services for inspecting the function repository. + */ + module meta { }; + +}; }; }; }; + +#endif + |