xref: /trunk/main/offapi/com/sun/star/sheet/XScenarios.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XScenarios_idl__
25#define __com_sun_star_sheet_XScenarios_idl__
26
27#ifndef __com_sun_star_container_XNameAccess_idl__
28#include <com/sun/star/container/XNameAccess.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellRangeAddress_idl__
32#include <com/sun/star/table/CellRangeAddress.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access via name to the scenarios in a collection and inserting
42	and removing scenarios.
43
44	@see com::sun::star::sheet::Scenarios
45	@see com::sun::star::sheet::Spreadsheet
46 */
47published interface XScenarios: com::sun::star::container::XNameAccess
48{
49	//-------------------------------------------------------------------------
50
51	/** creates a new scenario and adds it to the collection.
52
53		@param aName
54			the name of the scenario (used i.e. for collection access).
55
56		@param aRanges
57			the cell ranges contained in the scenario.
58
59		@param aComment
60			the user defined comment for the scenario.
61	 */
62	void addNewByName(
63			[in] string aName,
64			[in] sequence< com::sun::star::table::CellRangeAddress > aRanges,
65			[in] string aComment );
66
67	//-------------------------------------------------------------------------
68
69	/** removes a scenario from the collection.
70	 */
71	void removeByName( [in] string aName );
72
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80
81