xref: /trunk/main/offapi/com/sun/star/report/XFunction.idl (revision cdf0e10c) 
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_report_XFunction_idl__
28#define __com_sun_star_report_XFunction_idl__
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33#ifndef __com_sun_star_beans_Optional_idl__
34#include <com/sun/star/beans/Optional.idl>
35#endif
36#ifndef __com_sun_star_lang_XComponent_idl__
37#include <com/sun/star/lang/XComponent.idl>
38#endif
39#ifndef __com_sun_star_container_XChild_idl__
40#include <com/sun/star/container/XChild.idl>
41#endif
42//=============================================================================
43 module com {  module sun {  module star {  module report {
44//=============================================================================
45/** specifies a format condition for a control.
46*/
47published interface XFunction
48{
49    /** gives access to the properties.
50    */
51    interface com::sun::star::beans::XPropertySet;
52
53    /** allows life-time control of function instances.
54     */
55    interface com::sun::star::lang::XComponent;
56
57    /** allows the navigation to the functions object.
58        The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
59    */
60    interface com::sun::star::container::XChild;
61
62    /** specifies if the function should be evaluated before the report element will be executed.
63    */
64    [attribute,bound] boolean PreEvaluated;
65
66    /** specifies if sub reports should be traversed as well.
67    */
68    [attribute,bound] boolean DeepTraversing;
69
70    /** defines the name of the function
71    */
72    [attribute,bound] string Name;
73
74    /** defines the formular of this function
75    */
76    [attribute,bound] string Formula;
77
78    /** defines the formular for the intial value
79    */
80    [attribute,bound] com::sun::star::beans::Optional<string> InitialFormula;
81};
82
83service Function : XFunction
84{
85    create();
86};
87//=============================================================================
88
89}; }; }; };
90#endif
91