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_FunctionArgument_idl__
29#define __com_sun_star_sheet_FunctionArgument_idl__
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** contains the description of a single argument within a spreadsheet
38	function.
39
40	@see com::sun::star::sheet::FunctionDescription
41 */
42published struct FunctionArgument
43{
44	//-------------------------------------------------------------------------
45
46	/** the name of the argument.
47	 */
48	string Name;
49
50	//-------------------------------------------------------------------------
51
52	/** a description of the argument.
53	 */
54	string Description;
55
56	//-------------------------------------------------------------------------
57
58	/** determines whether the argument is optional.
59	 */
60	boolean IsOptional;
61
62};
63
64//=============================================================================
65
66}; }; }; };
67
68#endif
69
70