offapi/com/sun/star/report/XFunction.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_XFunction_idl__
  20 #define __com_sun_star_report_XFunction_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/beans/Optional.idl>
  24 #include <com/sun/star/lang/XComponent.idl>
  25 #include <com/sun/star/container/XChild.idl>
  26  module com {  module sun {  module star {  module report {
  27 /** specifies a format condition for a control.
  28 */
  29 interface XFunction
  30 {
  31     /** gives access to the properties.
  32     */
  33     interface com::sun::star::beans::XPropertySet;
  34
  35     /** allows life-time control of function instances.
  36      */
  37     interface com::sun::star::lang::XComponent;
  38
  39     /** allows the navigation to the functions object.
  40         The method setParent from XChild is not supported and will throw an exception when called.
  41     */
  42     interface com::sun::star::container::XChild;
  43
  44     /** specifies if the function should be evaluated before the report element will be executed.
  45     */
  46     [attribute,bound] boolean PreEvaluated;
  47
  48     /** specifies if sub reports should be traversed as well.
  49     */
  50     [attribute,bound] boolean DeepTraversing;
  51
  52     /** defines the name of the function
  53     */
  54     [attribute,bound] string Name;
  55
  56     /** defines the formula of this function
  57     */
  58     [attribute,bound] string Formula;
  59
  60     /** defines the formula for the initial value
  61     */
  62     [attribute,bound] com::sun::star::beans::Optional<string> InitialFormula;
  63 };
  64
  65
  66 }; }; }; };
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */