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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XReportEngine.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_report_meta_XFunctionDescription_idl__
  31 #define __com_sun_star_report_meta_XFunctionDescription_idl__
  32
  33 #include <com/sun/star/lang/DisposedException.idl>
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #include <com/sun/star/sheet/FunctionArgument.idl>
  37 //=============================================================================
  38 module com {  module sun {  module star {  module report { module meta {
  39
  40 interface XFunctionCategory;
  41
  42 /** identifies a <type>XFunctionDescription</type> which allows to retrieve the meta data of all supported functions.
  43
  44 */
  45 interface XFunctionDescription
  46 {
  47     /** gives access to the properties.
  48     */
  49     interface com::sun::star::beans::XPropertySet;
  50
  51     string createFormula([in] sequence< string > arguments )
  52         raises( ::com::sun::star::lang::DisposedException,
  53                 com::sun::star::lang::IllegalArgumentException,
  54                 ::com::sun::star::uno::Exception );
  55
  56     /** specifies the category number.
  57     */
  58     [attribute,readonly] XFunctionCategory Category;
  59
  60     /** returns the localized function's name.
  61      */
  62     [attribute,readonly] string Name;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** returns a localized description of the function.
  67      */
  68     [attribute,readonly] string Description;
  69
  70     /** returns the signature of the function.
  71      */
  72     [attribute,readonly] string Signature;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** returns a sequence of localized descriptions of the function's
  77         arguments (in the order specified by the function).
  78      */
  79     [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; }; };
  85
  86 /*=============================================================================
  87
  88 =============================================================================*/
  89
  90 #endif