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