offapi/com/sun/star/report/XFunctions.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFunctions.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_report_XFunctions_idl__
  31 #define __com_sun_star_report_XFunctions_idl__
  32
  33 #ifndef __com_sun_star_container_XChild_idl__
  34 #include <com/sun/star/container/XChild.idl>
  35 #endif
  36 #ifndef __com_sun_star_container_XContainer_idl__
  37 #include <com/sun/star/container/XContainer.idl>
  38 #endif
  39 #ifndef __com_sun_star_container_XIndexContainer_idl__
  40 #include <com/sun/star/container/XIndexContainer.idl>
  41 #endif
  42 #ifndef __com_sun_star_lang_XComponent_idl__
  43 #include <com/sun/star/lang/XComponent.idl>
  44 #endif
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module report {
  48 interface XReportDefinition;
  49 interface XFunction;
  50 //=============================================================================
  51
  52 /** This interface specifies the functions collections of the report definition or a group.
  53     @see XFunction
  54     @see XReportDefinition
  55  */
  56 interface XFunctions
  57 {
  58     /** allows to register listeners to be notified of changes in the container.
  59     */
  60     interface com::sun::star::container::XContainer;
  61     /** gives access to the group elements.
  62         The elements are of type <type>XFunction</type>.
  63     */
  64     interface com::sun::star::container::XIndexContainer;
  65
  66     /** allows the navigation to the report or group object.
  67         The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
  68     */
  69     interface com::sun::star::container::XChild;
  70
  71     /** allows life-time control of the functions instance.
  72      */
  73     interface com::sun::star::lang::XComponent;
  74
  75     /** factory method for <type>XFunction</type>.
  76     */
  77     com::sun::star::report::XFunction createFunction();
  78 };
  79
  80 //=============================================================================
  81 }; }; }; };
  82
  83 #endif