office-gobmx/offapi/com/sun/star/sheet/FunctionDescription.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * 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_sheet_FunctionDescription_idl__
#define __com_sun_star_sheet_FunctionDescription_idl__

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

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

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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */