offapi/com/sun/star/report/XFunction.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: XFunction.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_XFunction_idl__
  31 #define __com_sun_star_report_XFunction_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_Optional_idl__
  37 #include <com/sun/star/beans/Optional.idl>
  38 #endif
  39 #ifndef __com_sun_star_lang_XComponent_idl__
  40 #include <com/sun/star/lang/XComponent.idl>
  41 #endif
  42 #ifndef __com_sun_star_container_XChild_idl__
  43 #include <com/sun/star/container/XChild.idl>
  44 #endif
  45 //=============================================================================
  46  module com {  module sun {  module star {  module report {
  47 //=============================================================================
  48 /** specifies a format condition for a control.
  49 */
  50 interface XFunction
  51 {
  52     /** gives access to the properties.
  53     */
  54     interface com::sun::star::beans::XPropertySet;
  55
  56     /** allows life-time control of function instances.
  57      */
  58     interface com::sun::star::lang::XComponent;
  59
  60     /** allows the navigation to the functions object.
  61         The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
  62     */
  63     interface com::sun::star::container::XChild;
  64
  65     /** specifies if the function should be evaluated before the report element will be executed.
  66     */
  67     [attribute,bound] boolean PreEvaluated;
  68
  69     /** specifies if sub reports should be traversed as well.
  70     */
  71     [attribute,bound] boolean DeepTraversing;
  72
  73     /** defines the name of the function
  74     */
  75     [attribute,bound] string Name;
  76
  77     /** defines the formular of this function
  78     */
  79     [attribute,bound] string Formula;
  80
  81     /** defines the formular for the intial value
  82     */
  83     [attribute,bound] com::sun::star::beans::Optional<string> InitialFormula;
  84 };
  85
  86 service Function : XFunction
  87 {
  88     create();
  89 };
  90 //=============================================================================
  91
  92 }; }; }; };
  93 #endif