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