/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: FunctionDescription.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 04:41:15 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_FunctionDescription_idl__
#define __com_sun_star_sheet_FunctionDescription_idl__

#ifndef __com_sun_star_sheet_FunctionArgument_idl__
#include <com/sun/star/sheet/FunctionArgument.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** collects all properties used to describe a function.

    @see com::sun::star::sheet::FunctionDescriptions
 */
published service FunctionDescription
{
    //-------------------------------------------------------------------------

    /** returns the function's unique identifier.

        @see com::sun::star::sheet::XFunctionDescriptions
     */
    [readonly, property] long Id;

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

    /** returns the function's category.

        @see com::sun::star::sheet::FunctionCategory
     */
    [readonly, property] long Category;

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

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

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

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

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

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

};

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

}; }; }; };

#endif

