offapi/com/sun/star/sheet/XCellRangeMovement.idl

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