xref: /trunk/main/offapi/com/sun/star/report/XGroups.idl (revision cdf0e10c) 
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_report_XGroups_idl__
28#define __com_sun_star_report_XGroups_idl__
29
30#ifndef __com_sun_star_container_XChild_idl__
31#include <com/sun/star/container/XChild.idl>
32#endif
33#ifndef __com_sun_star_container_XContainer_idl__
34#include <com/sun/star/container/XContainer.idl>
35#endif
36#ifndef __com_sun_star_container_XIndexContainer_idl__
37#include <com/sun/star/container/XIndexContainer.idl>
38#endif
39#ifndef __com_sun_star_lang_XComponent_idl__
40#include <com/sun/star/lang/XComponent.idl>
41#endif
42//=============================================================================
43
44 module com {  module sun {  module star {  module report {
45published interface XReportDefinition;
46published interface XGroup;
47//=============================================================================
48
49/** This interface specifies the groups collections of the report definition.
50    @see XGroup
51    @see XReportDefinition
52 */
53published interface XGroups
54{
55    /** allows to register listeners to be notified of changes in the container.
56    */
57    interface com::sun::star::container::XContainer;
58    /** gives access to the group elements.
59        The elements are of type <type>XGroup</type>.
60    */
61    interface com::sun::star::container::XIndexContainer;
62
63    /** allows the navigation to the report object.
64    */
65    interface com::sun::star::container::XChild;
66
67    /** allows life-time control of the groups instance.
68     */
69    interface com::sun::star::lang::XComponent;
70
71    /** factory method for <type>XGroup</type>.
72    */
73    com::sun::star::report::XGroup createGroup();
74
75    [attribute,readonly] com::sun::star::report::XReportDefinition ReportDefinition;
76};
77
78service Groups : XGroups;
79//=============================================================================
80
81}; }; }; };
82
83#endif
84