1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__
29#define __com_sun_star_sheet_XCellRangeMovement_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellRangeAddress_idl__
36#include <com/sun/star/table/CellRangeAddress.idl>
37#endif
38
39#ifndef __com_sun_star_sheet_CellInsertMode_idl__
40#include <com/sun/star/sheet/CellInsertMode.idl>
41#endif
42
43#ifndef __com_sun_star_sheet_CellDeleteMode_idl__
44#include <com/sun/star/sheet/CellDeleteMode.idl>
45#endif
46
47#ifndef __com_sun_star_table_CellAddress_idl__
48#include <com/sun/star/table/CellAddress.idl>
49#endif
50
51//=============================================================================
52
53module com {  module sun {  module star {  module sheet {
54
55//=============================================================================
56
57/** provides methods for moving ranges of cells in a sheet.
58 */
59published interface XCellRangeMovement: com::sun::star::uno::XInterface
60{
61	//-------------------------------------------------------------------------
62
63	/** inserts cells, moving other cells down or right.
64
65		<p>Non-empty cells cannot be moved off the sheet.</p>
66
67		@param aRange
68			the cell range in which empty cells will be inserted.
69
70		@param nMode
71			describes how to move existing cells.
72	 */
73	void insertCells(
74			[in] com::sun::star::table::CellRangeAddress aRange,
75			[in] com::sun::star::sheet::CellInsertMode nMode );
76
77	//-------------------------------------------------------------------------
78
79	/** deletes cells, moving other cells up or left.
80
81		@param aRange
82			the cell range to remove.
83
84		@param nMode
85			describes how to move following cells.
86	 */
87	void removeRange(
88			[in] com::sun::star::table::CellRangeAddress aRange,
89			[in] com::sun::star::sheet::CellDeleteMode nMode );
90
91	//-------------------------------------------------------------------------
92
93	/** moves a cell range to another position in the document.
94
95		<p>After copying the contents of the cell range, all cells
96		will be cleared.</p>
97
98		@param aDestination
99			the address of the top left cell of the destination range.
100
101		@param aSource
102			the cell range which will be copied.
103	 */
104	void moveRange(
105			[in] com::sun::star::table::CellAddress aDestination,
106			[in] com::sun::star::table::CellRangeAddress aSource );
107
108	//-------------------------------------------------------------------------
109
110	/** copies a cell range to another position in the document.
111
112		<p>The source cell range keeps unchanged.</p>
113
114		@param aDestination
115			the address of the top left cell of the destination range.
116
117		@param aSource
118			the cell range which will be copied.
119	 */
120	void copyRange(
121			[in] com::sun::star::table::CellAddress aDestination,
122			[in] com::sun::star::table::CellRangeAddress aSource );
123
124};
125
126//=============================================================================
127
128}; }; }; };
129
130#endif
131
132