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