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

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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