1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_report_meta_XFunctionDescription_idl__
24#define __com_sun_star_report_meta_XFunctionDescription_idl__
25
26#include <com/sun/star/lang/DisposedException.idl>
27#include <com/sun/star/lang/IllegalArgumentException.idl>
28#include <com/sun/star/beans/XPropertySet.idl>
29#include <com/sun/star/sheet/FunctionArgument.idl>
30//=============================================================================
31module com {  module sun {  module star {  module report { module meta {
32
33published interface XFunctionCategory;
34
35/** identifies a <type>XFunctionDescription</type> which allows to retrieve the meta data of all supported functions.
36
37*/
38published interface XFunctionDescription
39{
40    /** gives access to the properties.
41    */
42    interface com::sun::star::beans::XPropertySet;
43
44    string createFormula([in] sequence< string > arguments )
45        raises( ::com::sun::star::lang::DisposedException,
46                com::sun::star::lang::IllegalArgumentException,
47                ::com::sun::star::uno::Exception );
48
49    /** specifies the category number.
50    */
51    [attribute,readonly] XFunctionCategory Category;
52
53    /** returns the localized function's name.
54     */
55    [attribute,readonly] string Name;
56
57    //-------------------------------------------------------------------------
58
59    /** returns a localized description of the function.
60     */
61    [attribute,readonly] string Description;
62
63    /** returns the signature of the function.
64     */
65    [attribute,readonly] string Signature;
66
67    //-------------------------------------------------------------------------
68
69    /** returns a sequence of localized descriptions of the function's
70        arguments (in the order specified by the function).
71     */
72    [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
73};
74
75//=============================================================================
76
77}; }; }; }; };
78
79/*=============================================================================
80
81=============================================================================*/
82
83#endif
84