xref: /aoo41x/main/offapi/com/sun/star/sheet/XCellRangeMovement.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_XCellRangeMovement_idl__
#define __com_sun_star_sheet_XCellRangeMovement_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

#ifndef __com_sun_star_sheet_CellInsertMode_idl__
#include <com/sun/star/sheet/CellInsertMode.idl>
#endif

#ifndef __com_sun_star_sheet_CellDeleteMode_idl__
#include <com/sun/star/sheet/CellDeleteMode.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

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

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

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

/** provides methods for moving ranges of cells in a sheet.
 */
published interface XCellRangeMovement: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** inserts cells, moving other cells down or right.

		<p>Non-empty cells cannot be moved off the sheet.</p>

		@param aRange
			the cell range in which empty cells will be inserted.

		@param nMode
			describes how to move existing cells.
	 */
	void insertCells(
			[in] com::sun::star::table::CellRangeAddress aRange,
			[in] com::sun::star::sheet::CellInsertMode nMode );

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

	/** deletes cells, moving other cells up or left.

		@param aRange
			the cell range to remove.

		@param nMode
			describes how to move following cells.
	 */
	void removeRange(
			[in] com::sun::star::table::CellRangeAddress aRange,
			[in] com::sun::star::sheet::CellDeleteMode nMode );

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

	/** moves a cell range to another position in the document.

		<p>After copying the contents of the cell range, all cells
		will be cleared.</p>

		@param aDestination
			the address of the top left cell of the destination range.

		@param aSource
			the cell range which will be copied.
	 */
	void moveRange(
			[in] com::sun::star::table::CellAddress aDestination,
			[in] com::sun::star::table::CellRangeAddress aSource );

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

	/** copies a cell range to another position in the document.

		<p>The source cell range keeps unchanged.</p>

		@param aDestination
			the address of the top left cell of the destination range.

		@param aSource
			the cell range which will be copied.
	 */
	void copyRange(
			[in] com::sun::star::table::CellAddress aDestination,
			[in] com::sun::star::table::CellRangeAddress aSource );

};

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

}; }; }; };

#endif