xref: /aoo42x/main/offapi/com/sun/star/report/XFunction.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_report_XFunction_idl__
#define __com_sun_star_report_XFunction_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_beans_Optional_idl__
#include <com/sun/star/beans/Optional.idl>
#endif
#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif
#ifndef __com_sun_star_container_XChild_idl__
#include <com/sun/star/container/XChild.idl>
#endif
//=============================================================================
 module com {  module sun {  module star {  module report {
//=============================================================================
/** specifies a format condition for a control.
*/
published interface XFunction
{
    /** gives access to the properties.
    */
    interface com::sun::star::beans::XPropertySet;

    /** allows life-time control of function instances.
     */
    interface com::sun::star::lang::XComponent;

    /** allows the navigation to the functions object.
        The method setParent from <type>XChild</type> is not supported and will throw an exception when called.
    */
    interface com::sun::star::container::XChild;

    /** specifies if the function should be evaluated before the report element will be executed.
    */
    [attribute,bound] boolean PreEvaluated;

    /** specifies if sub reports should be traversed as well.
    */
    [attribute,bound] boolean DeepTraversing;

    /** defines the name of the function
    */
    [attribute,bound] string Name;

    /** defines the formular of this function
    */
    [attribute,bound] string Formula;

    /** defines the formular for the intial value
    */
    [attribute,bound] com::sun::star::beans::Optional<string> InitialFormula;
};

service Function : XFunction
{
    create();
};
//=============================================================================

}; }; }; };
#endif