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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides methods for moving ranges of cells in a sheet.
  25  */
  26 published interface XCellRangeMovement: com::sun::star::uno::XInterface
  27 {
  28
  29     /** inserts cells, moving other cells down or right.
  30
  31         <p>Non-empty cells cannot be moved off the sheet.</p>
  32
  33         @param aRange
  34             the cell range in which empty cells will be inserted.
  35
  36         @param nMode
  37             describes how to move existing cells.
  38      */
  39     void insertCells(
  40             [in] com::sun::star::table::CellRangeAddress aRange,
  41             [in] com::sun::star::sheet::CellInsertMode nMode );
  42
  43
  44     /** deletes cells, moving other cells up or left.
  45
  46         @param aRange
  47             the cell range to remove.
  48
  49         @param nMode
  50             describes how to move following cells.
  51      */
  52     void removeRange(
  53             [in] com::sun::star::table::CellRangeAddress aRange,
  54             [in] com::sun::star::sheet::CellDeleteMode nMode );
  55
  56
  57     /** moves a cell range to another position in the document.
  58
  59         <p>After copying the contents of the cell range, all cells
  60         will be cleared.</p>
  61
  62         @param aDestination
  63             the address of the top left cell of the destination range.
  64
  65         @param aSource
  66             the cell range which will be copied.
  67      */
  68     void moveRange(
  69             [in] com::sun::star::table::CellAddress aDestination,
  70             [in] com::sun::star::table::CellRangeAddress aSource );
  71
  72
  73     /** copies a cell range to another position in the document.
  74
  75         <p>The source cell range keeps unchanged.</p>
  76
  77         @param aDestination
  78             the address of the top left cell of the destination range.
  79
  80         @param aSource
  81             the cell range which will be copied.
  82      */
  83     void copyRange(
  84             [in] com::sun::star::table::CellAddress aDestination,
  85             [in] com::sun::star::table::CellRangeAddress aSource );
  86
  87 };
  88
  89
  90 }; }; }; };
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */