offapi/com/sun/star/report/meta/XFunctionDescription.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_XFunctionDescription_idl__
  20 #define __com_sun_star_report_meta_XFunctionDescription_idl__
  21
  22 #include <com/sun/star/lang/DisposedException.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/sheet/FunctionArgument.idl>
  26 module com {  module sun {  module star {  module report { module meta {
  27
  28 interface XFunctionCategory;
  29
  30 /** identifies a XFunctionDescription which allows to retrieve the meta data of all supported functions.
  31
  32 */
  33 interface XFunctionDescription
  34 {
  35     /** gives access to the properties.
  36     */
  37     interface com::sun::star::beans::XPropertySet;
  38
  39     string createFormula([in] sequence< string > arguments )
  40         raises( ::com::sun::star::lang::DisposedException,
  41                 com::sun::star::lang::IllegalArgumentException,
  42                 ::com::sun::star::uno::Exception );
  43
  44     /** specifies the category number.
  45     */
  46     [attribute,readonly] XFunctionCategory Category;
  47
  48     /** returns the localized function's name.
  49      */
  50     [attribute,readonly] string Name;
  51
  52
  53     /** returns a localized description of the function.
  54      */
  55     [attribute,readonly] string Description;
  56
  57     /** returns the signature of the function.
  58      */
  59     [attribute,readonly] string Signature;
  60
  61
  62     /** returns a sequence of localized descriptions of the function's
  63         arguments (in the order specified by the function).
  64      */
  65     [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
  66 };
  67
  68
  69 }; }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */