xref: /trunk/main/offapi/com/sun/star/report/XFunction.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_report_XFunction_idl__
24#define __com_sun_star_report_XFunction_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29#ifndef __com_sun_star_beans_Optional_idl__
30#include <com/sun/star/beans/Optional.idl>
31#endif
32#ifndef __com_sun_star_lang_XComponent_idl__
33#include <com/sun/star/lang/XComponent.idl>
34#endif
35#ifndef __com_sun_star_container_XChild_idl__
36#include <com/sun/star/container/XChild.idl>
37#endif
38//=============================================================================
39 module com {  module sun {  module star {  module report {
40//=============================================================================
41/** specifies a format condition for a control.
42*/
43published interface XFunction
44{
45    /** gives access to the properties.
46    */
47    interface com::sun::star::beans::XPropertySet;
48
49    /** allows life-time control of function instances.
50     */
51    interface com::sun::star::lang::XComponent;
52
53    /** allows the navigation to the functions object.
54        The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
55    */
56    interface com::sun::star::container::XChild;
57
58    /** specifies if the function should be evaluated before the report element will be executed.
59    */
60    [attribute,bound] boolean PreEvaluated;
61
62    /** specifies if sub reports should be traversed as well.
63    */
64    [attribute,bound] boolean DeepTraversing;
65
66    /** defines the name of the function
67    */
68    [attribute,bound] string Name;
69
70    /** defines the formular of this function
71    */
72    [attribute,bound] string Formula;
73
74    /** defines the formular for the intial value
75    */
76    [attribute,bound] com::sun::star::beans::Optional<string> InitialFormula;
77};
78
79service Function : XFunction
80{
81    create();
82};
83//=============================================================================
84
85}; }; }; };
86#endif
87