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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XCellRangeMovement_idl__
  21 #define __com_sun_star_sheet_XCellRangeMovement_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25 #include <com/sun/star/sheet/CellInsertMode.idl>
  26 #include <com/sun/star/sheet/CellDeleteMode.idl>
  27 #include <com/sun/star/table/CellAddress.idl>
  28
  29
  30 module com {  module sun {  module star {  module sheet {
  31
  32
  33 /** provides methods for moving ranges of cells in a sheet.
  34  */
  35 published interface XCellRangeMovement: com::sun::star::uno::XInterface
  36 {
  37
  38     /** inserts cells, moving other cells down or right.
  39
  40         <p>Non-empty cells cannot be moved off the sheet.</p>
  41
  42         @param aRange
  43             the cell range in which empty cells will be inserted.
  44
  45         @param nMode
  46             describes how to move existing cells.
  47      */
  48     void insertCells(
  49             [in] com::sun::star::table::CellRangeAddress aRange,
  50             [in] com::sun::star::sheet::CellInsertMode nMode );
  51
  52
  53     /** deletes cells, moving other cells up or left.
  54
  55         @param aRange
  56             the cell range to remove.
  57
  58         @param nMode
  59             describes how to move following cells.
  60      */
  61     void removeRange(
  62             [in] com::sun::star::table::CellRangeAddress aRange,
  63             [in] com::sun::star::sheet::CellDeleteMode nMode );
  64
  65
  66     /** moves a cell range to another position in the document.
  67
  68         <p>After copying the contents of the cell range, all cells
  69         will be cleared.</p>
  70
  71         @param aDestination
  72             the address of the top left cell of the destination range.
  73
  74         @param aSource
  75             the cell range which will be copied.
  76      */
  77     void moveRange(
  78             [in] com::sun::star::table::CellAddress aDestination,
  79             [in] com::sun::star::table::CellRangeAddress aSource );
  80
  81
  82     /** copies a cell range to another position in the document.
  83
  84         <p>The source cell range keeps unchanged.</p>
  85
  86         @param aDestination
  87             the address of the top left cell of the destination range.
  88
  89         @param aSource
  90             the cell range which will be copied.
  91      */
  92     void copyRange(
  93             [in] com::sun::star::table::CellAddress aDestination,
  94             [in] com::sun::star::table::CellRangeAddress aSource );
  95
  96 };
  97
  98
  99 }; }; }; };
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */