offapi/com/sun/star/sheet/XSheetCellRangeContainer.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 to access cell ranges in a collection via index and
  25     to add and remove cell ranges.
  26
  27     @see com::sun::star::sheet::SheetCellRanges
  28  */
  29 published interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges
  30 {
  31
  32     /** adds the given range to the collection of cell ranges.
  33
  34         @param aCellRangeAddress
  35             contains the address of the new range.
  36
  37         @param bMergeRanges
  38             defines how the range should be added. To merge the ranges
  39             takes more time, but the memory usage is lower.
  40      */
  41     void addRangeAddress(
  42             [in] com::sun::star::table::CellRangeAddress aCellRangeAddress,
  43             [in] boolean bMergeRanges );
  44
  45
  46     /** removes the given range from the collection of cell ranges.
  47
  48         @param aCellRangeAddress
  49             contains the address of the range to be removed.
  50
  51             <p>The specified range must fit exactly to an element of the
  52             collection. The method does not try to shorten a range.</p>
  53
  54         @throws com::sun::star::container::NoSuchElementException
  55             if the collection does not contain the specified range.
  56      */
  57     void removeRangeAddress(
  58             [in] com::sun::star::table::CellRangeAddress aCellRangeAddress )
  59         raises( com::sun::star::container::NoSuchElementException );
  60
  61
  62     /** adds the given ranges to the collection of cell ranges.
  63
  64         @param aCellRangeAddresses
  65             contains a sequence of addresses of all new ranges.
  66
  67         @param bMergeRanges
  68             defines how the ranges should be added. To merge the ranges
  69             takes more time, but the memory usage is lower.
  70      */
  71     void addRangeAddresses(
  72             [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses,
  73             [in] boolean bMergeRanges );
  74
  75
  76     /** removes the given ranges from the collection of cell ranges.
  77
  78         @param aCellRangeAddresses
  79             contains a sequence of addresses of all ranges to be removed.
  80
  81             <p>All specified ranges must fit exactly to elements of the
  82             collection. The method does not try to shorten ranges.</p>
  83
  84         @throws com::sun::star::container::NoSuchElementException
  85             if the collection does not contain any of the specified ranges.
  86      */
  87     void removeRangeAddresses(
  88             [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses )
  89         raises( com::sun::star::container::NoSuchElementException);
  90
  91 };
  92
  93
  94 }; }; }; };
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */