/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: Scenario.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 04:46:47 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_Scenario_idl__
#define __com_sun_star_sheet_Scenario_idl__

#ifndef __com_sun_star_sheet_XScenario_idl__
#include <com/sun/star/sheet/XScenario.idl>
#endif

#ifndef __com_sun_star_sheet_XScenarioEnhanced_idl__
#include <com/sun/star/sheet/XScenarioEnhanced.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a scenario in a spreadsheet document.

 */
service Scenario
{
    interface com::sun::star::sheet::XScenario;

    [optional] interface com::sun::star::sheet::XScenarioEnhanced;

    interface com::sun::star::beans::XPropertySet;

    interface com::sun::star::container::XNamed;

    //-------------------------------------------------------------------------

    /** specifies if the scenario is active.
     */
    [optional, property] boolean IsActive;

    //-------------------------------------------------------------------------

    /** specifies the color of the border of the scenario.
     */
    [optional, property] long BorderColor;

    //-------------------------------------------------------------------------

    /** specifies if the scenario is protected.
     */
    [optional, property] boolean Protected;

    //-------------------------------------------------------------------------

    /** specifies if the scenario shows a border.
     */
    [optional, property] boolean ShowBorder;

    //-------------------------------------------------------------------------

    /** specifies if the scenario prints a border.
     */
    [optional, property] boolean PrintBorder;

    //-------------------------------------------------------------------------

    /** specifies if the data should be copied back into the scenario.
     */
    [optional, property] boolean CopyBack;

    //-------------------------------------------------------------------------

    /** specifies if the styles are copied.
     */
    [optional, property] boolean CopyStyles;

    //-------------------------------------------------------------------------

    /** specifies if the formulas are copied or only the results.
     */
    [optional, property] boolean CopyFormulas;


};

//=============================================================================

}; }; }; };

#endif

