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_XFunctionDescriptions_idl__
25#define __com_sun_star_sheet_XFunctionDescriptions_idl__
26
27#ifndef __com_sun_star_container_XIndexAccess_idl__
28#include <com/sun/star/container/XIndexAccess.idl>
29#endif
30
31#ifndef __com_sun_star_beans_PropertyValue_idl__
32#include <com/sun/star/beans/PropertyValue.idl>
33#endif
34
35#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides access to the property sequence of a function description
46	via function index or identifier.
47
48	<p>The 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 service
51	<type>FunctionDescription</type>.</p>
52
53	@see com::sun::star::sheet::FunctionDescriptions
54 */
55published interface XFunctionDescriptions: com::sun::star::container::XIndexAccess
56{
57	//-------------------------------------------------------------------------
58
59	/** finds a function description by the identifier of the function.
60
61		@param nId
62			is the identifier of the function description (the same that
63			is used in the service <type>RecentFunctions</type>.</p>
64
65		@returns
66			the sequence of property values (described in
67			<type>FunctionDescription</type>).
68	 */
69	sequence< com::sun::star::beans::PropertyValue > getById( [in] long nId )
70		raises( com::sun::star::lang::IllegalArgumentException );
71
72};
73
74//=============================================================================
75
76}; }; }; };
77
78#endif
79
80