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