xref: /AOO41X/main/offapi/com/sun/star/sheet/FunctionDescriptions.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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
24#ifndef __com_sun_star_sheet_FunctionDescriptions_idl__
25#define __com_sun_star_sheet_FunctionDescriptions_idl__
26
27#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__
28#include <com/sun/star/sheet/XFunctionDescriptions.idl>
29#endif
30
31#ifndef __com_sun_star_container_XNameAccess_idl__
32#include <com/sun/star/container/XNameAccess.idl>
33#endif
34#ifndef __com_sun_star_container_XEnumerationAccess_idl__
35#include <com/sun/star/container/XEnumerationAccess.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module sheet {
41
42//=============================================================================
43
44/** represents a collection of function descriptions for all built-in
45    functions as well as add-in functions available in the spreadsheet
46    application.
47
48    <p>All container access methods return a sequence of
49    <type scope="com::sun::star::beans">PropertyValue</type> structs.
50    The properties contained in the sequence are collected in the
51    service <type>FunctionDescription</type>.</p>
52 */
53published service FunctionDescriptions
54{
55    //-------------------------------------------------------------------------
56
57    /** provides access to the property sequence of a function description
58        via function index or identifier.
59     */
60    interface com::sun::star::sheet::XFunctionDescriptions;
61
62    //-------------------------------------------------------------------------
63
64    /** provides access to the property sequence of a function description
65        via function name.
66
67        <p>The localized uppercase name of the function has to be used
68        here.</p>
69     */
70    interface com::sun::star::container::XNameAccess;
71
72    //-------------------------------------------------------------------------
73
74    /** creates an enumeration of all function descriptions.
75
76        @see com::sun::star::sheet::FunctionDescriptionEnumeration
77     */
78    interface com::sun::star::container::XEnumerationAccess;
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87
88