1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XReportEngine.idl,v $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
30 #ifndef __com_sun_star_report_meta_XFunctionCategory_idl__
31 #define __com_sun_star_report_meta_XFunctionCategory_idl__
33 #include
<com
/sun
/star
/container
/XIndexAccess.idl
>
34 #include
<com
/sun
/star
/lang
/DisposedException.idl
>
35 #include
<com
/sun
/star
/beans
/XPropertySet.idl
>
37 //=============================================================================
38 module com
{ module sun
{ module star
{ module report
{ module meta
{
40 interface XFunctionDescription
;
41 /** identifies a <type>XFunctionCategory</type> which allows to retrieve the meta data of all supported functions.
45 interface XFunctionCategory
47 /** gives access to the properties.
49 interface com
::sun
::star
::beans
::XPropertySet
;
51 /** gives access to all categories
53 interface com
::sun
::star
::container
::XIndexAccess
;
55 /** same as getByIndex.
56 @see com.ssun.star.container.XIndexAccess
58 XFunctionDescription getFunction
([in] long position
)
59 raises
( com
::sun
::star
::lang
::IndexOutOfBoundsException
,
60 com
::sun
::star
::lang
::WrappedTargetException
);
62 /** returns the localized category's name.
64 [attribute
,readonly] string Name
;
66 /** specifies the category number.
68 [attribute
,readonly] long Number
;
71 //=============================================================================
75 /*=============================================================================
77 =============================================================================*/