offapi/com/sun/star/report/meta/XFunctionManager.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_report_meta_XFunctionManager_idl__
  20 #define __com_sun_star_report_meta_XFunctionManager_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25 #include <com/sun/star/lang/DisposedException.idl>
  26 #include <com/sun/star/report/meta/XFunctionCategory.idl>
  27 #include <com/sun/star/report/meta/XFunctionDescription.idl>
  28
  29 module com {  module sun {  module star {  module report { module meta {
  30 /** identifies a XFunctionManager which allows to retrieve the meta data of all supported functions.
  31
  32 */
  33 interface XFunctionManager
  34 {
  35     /** allows life-time control of report engine.
  36      */
  37     interface com::sun::star::lang::XComponent;
  38     /** gives access to all categories
  39     */
  40     interface com::sun::star::container::XIndexAccess;
  41
  42     /** same as getByIndex.
  43         @param  position    The position.
  44         @see com.sun.star.container.XIndexAccess
  45     */
  46     XFunctionCategory getCategory([in] long position)
  47         raises( com::sun::star::lang::IndexOutOfBoundsException,
  48                     com::sun::star::lang::WrappedTargetException );
  49
  50     /** get the function description by name
  51         @param  name    the name of the function
  52     */
  53     XFunctionDescription getFunctionByName([in] string name)
  54         raises( com::sun::star::container::NoSuchElementException);
  55 };
  56
  57
  58 }; }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */