1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_report_meta_XFunctionDescription_idl__
28#define __com_sun_star_report_meta_XFunctionDescription_idl__
29
30#include <com/sun/star/lang/DisposedException.idl>
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#include <com/sun/star/beans/XPropertySet.idl>
33#include <com/sun/star/sheet/FunctionArgument.idl>
34//=============================================================================
35module com {  module sun {  module star {  module report { module meta {
36
37published interface XFunctionCategory;
38
39/** identifies a <type>XFunctionDescription</type> which allows to retrieve the meta data of all supported functions.
40
41*/
42published interface XFunctionDescription
43{
44    /** gives access to the properties.
45    */
46    interface com::sun::star::beans::XPropertySet;
47
48    string createFormula([in] sequence< string > arguments )
49        raises( ::com::sun::star::lang::DisposedException,
50                com::sun::star::lang::IllegalArgumentException,
51                ::com::sun::star::uno::Exception );
52
53    /** specifies the category number.
54    */
55    [attribute,readonly] XFunctionCategory Category;
56
57    /** returns the localized function's name.
58     */
59    [attribute,readonly] string Name;
60
61    //-------------------------------------------------------------------------
62
63    /** returns a localized description of the function.
64     */
65    [attribute,readonly] string Description;
66
67    /** returns the signature of the function.
68     */
69    [attribute,readonly] string Signature;
70
71    //-------------------------------------------------------------------------
72
73    /** returns a sequence of localized descriptions of the function's
74        arguments (in the order specified by the function).
75     */
76    [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
77};
78
79//=============================================================================
80
81}; }; }; }; };
82
83/*=============================================================================
84
85=============================================================================*/
86
87#endif
88