/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_report_meta_XFunctionDescription_idl__
#define __com_sun_star_report_meta_XFunctionDescription_idl__

#include <com/sun/star/lang/DisposedException.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/sheet/FunctionArgument.idl>
//=============================================================================
module com {  module sun {  module star {  module report { module meta {

published interface XFunctionCategory;

/** identifies a <type>XFunctionDescription</type> which allows to retrieve the meta data of all supported functions.

*/
published interface XFunctionDescription
{
    /** gives access to the properties.
    */
    interface com::sun::star::beans::XPropertySet;

    string createFormula([in] sequence< string > arguments )
        raises( ::com::sun::star::lang::DisposedException,
                com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::uno::Exception );

    /** specifies the category number.
    */
    [attribute,readonly] XFunctionCategory Category;

    /** returns the localized function's name.
     */
    [attribute,readonly] string Name;

    //-------------------------------------------------------------------------

    /** returns a localized description of the function.
     */
    [attribute,readonly] string Description;

    /** returns the signature of the function.
     */
    [attribute,readonly] string Signature;

    //-------------------------------------------------------------------------

    /** returns a sequence of localized descriptions of the function's
        arguments (in the order specified by the function).
     */
    [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
};

//=============================================================================

}; }; }; }; };

/*=============================================================================

=============================================================================*/

#endif