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_FunctionDescription_idl__
29#define __com_sun_star_sheet_FunctionDescription_idl__
30
31#ifndef __com_sun_star_sheet_FunctionArgument_idl__
32#include <com/sun/star/sheet/FunctionArgument.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** collects all properties used to describe a function.
42
43	@see com::sun::star::sheet::FunctionDescriptions
44 */
45published service FunctionDescription
46{
47	//-------------------------------------------------------------------------
48
49	/** returns the function's unique identifier.
50
51		@see com::sun::star::sheet::XFunctionDescriptions
52	 */
53	[readonly, property] long Id;
54
55	//-------------------------------------------------------------------------
56
57	/** returns the function's category.
58
59		@see com::sun::star::sheet::FunctionCategory
60	 */
61	[readonly, property] long Category;
62
63	//-------------------------------------------------------------------------
64
65	/** returns the localized function's name.
66	 */
67	[readonly, property] string Name;
68
69	//-------------------------------------------------------------------------
70
71	/** returns a localized description of the function.
72	 */
73	[readonly, property] string Description;
74
75	//-------------------------------------------------------------------------
76
77	/** returns a sequence of localized descriptions of the function's
78		arguments (in the order specified by the function).
79	 */
80	[readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
81
82};
83
84//=============================================================================
85
86}; }; }; };
87
88#endif
89
90