diff options
Diffstat (limited to 'offapi/com/sun/star/report/meta')
| -rw-r--r-- | offapi/com/sun/star/report/meta/XFormulaParser.idl | 72 | ||||
| -rw-r--r-- | offapi/com/sun/star/report/meta/XFunctionCategory.idl | 76 | ||||
| -rw-r--r-- | offapi/com/sun/star/report/meta/XFunctionDescription.idl | 87 | ||||
| -rw-r--r-- | offapi/com/sun/star/report/meta/XFunctionManager.idl | 74 | ||||
| -rw-r--r-- | offapi/com/sun/star/report/meta/makefile.mk | 49 |
5 files changed, 358 insertions, 0 deletions
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 |