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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_report_XFunctions_idl__
  20 #define __com_sun_star_report_XFunctions_idl__
  21
  22 #include <com/sun/star/container/XChild.idl>
  23 #include <com/sun/star/container/XContainer.idl>
  24 #include <com/sun/star/container/XIndexContainer.idl>
  25 #include <com/sun/star/lang/XComponent.idl>
  26 #include <com/sun/star/report/XFunction.idl>
  27
  28 module com {  module sun {  module star {  module report {
  29
  30 interface XReportDefinition;
  31
  32 /** This interface specifies the functions collections of the report definition or a group.
  33     @see XFunction
  34     @see XReportDefinition
  35  */
  36 interface XFunctions
  37 {
  38     /** allows to register listeners to be notified of changes in the container.
  39     */
  40     interface com::sun::star::container::XContainer;
  41     /** gives access to the group elements.
  42         The elements are of type XFunction.
  43     */
  44     interface com::sun::star::container::XIndexContainer;
  45
  46     /** allows the navigation to the report or group object.
  47         The method setParent from XChild is not supported and will throw an exception when called.
  48     */
  49     interface com::sun::star::container::XChild;
  50
  51     /** allows life-time control of the functions instance.
  52      */
  53     interface com::sun::star::lang::XComponent;
  54
  55     /** factory method for XFunction.
  56     */
  57     com::sun::star::report::XFunction createFunction();
  58 };
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */