AOO410/main/offapi/com/sun/star/sheet/Scenario.idl

/**************************************************************
 * 
 * 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_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