diff options
Diffstat (limited to 'offapi/com/sun/star/report/meta/XFunctionManager.idl')
-rw-r--r-- | offapi/com/sun/star/report/meta/XFunctionManager.idl | 74 |
1 files changed, 74 insertions, 0 deletions
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 |