xref: /aoo41x/main/offapi/com/sun/star/sheet/XScenarios.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_sheet_XScenarios_idl__
#define __com_sun_star_sheet_XScenarios_idl__

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

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

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

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

/** provides access via name to the scenarios in a collection and inserting
	and removing scenarios.

	@see com::sun::star::sheet::Scenarios
	@see com::sun::star::sheet::Spreadsheet
 */
published interface XScenarios: com::sun::star::container::XNameAccess
{
	//-------------------------------------------------------------------------

	/** creates a new scenario and adds it to the collection.

		@param aName
			the name of the scenario (used i.e. for collection access).

		@param aRanges
			the cell ranges contained in the scenario.

		@param aComment
			the user defined comment for the scenario.
	 */
	void addNewByName(
			[in] string aName,
			[in] sequence< com::sun::star::table::CellRangeAddress > aRanges,
			[in] string aComment );

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

	/** removes a scenario from the collection.
	 */
	void removeByName( [in] string aName );

};

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

}; }; }; };

#endif