/* -*- 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_report_meta_XFunctionCategory_idl__
#define __com_sun_star_report_meta_XFunctionCategory_idl__

#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/lang/DisposedException.idl>
#include <com/sun/star/beans/XPropertySet.idl>

//=============================================================================
module com {  module sun {  module star {  module report { module meta {

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

*/

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

    /** gives access to all categories
    */
    interface com::sun::star::container::XIndexAccess;

    /** same as getByIndex.
        @see com.sun.star.container.XIndexAccess
    */
    XFunctionDescription getFunction([in] long position)
        raises( com::sun::star::lang::IndexOutOfBoundsException,
                    com::sun::star::lang::WrappedTargetException );

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

    /** specifies the category number.
    */
    [attribute,readonly] long Number;
};

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

}; }; }; }; };

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

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

#endif

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