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#ifndef __com_sun_star_report_meta_XFunctionCategory_idl__
28#define __com_sun_star_report_meta_XFunctionCategory_idl__
29
30#include <com/sun/star/container/XIndexAccess.idl>
31#include <com/sun/star/lang/DisposedException.idl>
32#include <com/sun/star/beans/XPropertySet.idl>
33
34//=============================================================================
35module com {  module sun {  module star {  module report { module meta {
36
37published interface XFunctionDescription;
38/** identifies a <type>XFunctionCategory</type> which allows to retrieve the meta data of all supported functions.
39
40*/
41
42published interface XFunctionCategory
43{
44    /** gives access to the properties.
45    */
46    interface com::sun::star::beans::XPropertySet;
47
48    /** gives access to all categories
49    */
50    interface com::sun::star::container::XIndexAccess;
51
52    /** same as getByIndex.
53        @see com.ssun.star.container.XIndexAccess
54    */
55    XFunctionDescription getFunction([in] long position)
56        raises( com::sun::star::lang::IndexOutOfBoundsException,
57                    com::sun::star::lang::WrappedTargetException );
58
59    /** returns the localized category's name.
60     */
61    [attribute,readonly] string Name;
62
63    /** specifies the category number.
64    */
65    [attribute,readonly] long Number;
66};
67
68//=============================================================================
69
70}; }; }; }; };
71
72/*=============================================================================
73
74=============================================================================*/
75
76#endif
77