summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/report/meta/XFunctionManager.idl
blob: f40b506ea9067acdab9d2c972f6617308389b8fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/**
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_report_meta_XFunctionManager_idl__
#define __com_sun_star_report_meta_XFunctionManager_idl__

#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
#include <com/sun/star/lang/DisposedException.idl>
#include <com/sun/star/report/meta/XFunctionCategory.idl>
#include <com/sun/star/report/meta/XFunctionDescription.idl>

module com {  module sun {  module star {  module report { module meta {
/** identifies a <type>XFunctionManager</type> which allows to retrieve the meta data of all supported functions.

*/
interface XFunctionManager
{
    /** allows life-time control of report engine.
     */
    interface com::sun::star::lang::XComponent;
    /** gives access to all categories
    */
    interface com::sun::star::container::XIndexAccess;

    /** same as getByIndex.
        @param  position    The position.
        @see com.sun.star.container.XIndexAccess
    */
    XFunctionCategory getCategory([in] long position)
        raises( com::sun::star::lang::IndexOutOfBoundsException,
                    com::sun::star::lang::WrappedTargetException );

    /** get the function description by name
        @param  name    the name of the function
    */
    XFunctionDescription getFunctionByName([in] string name)
        raises( com::sun::star::container::NoSuchElementException);
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */