offapi/com/sun/star/sheet/XSheetCellRangeContainer.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: XSheetCellRangeContainer.idl,v $
  10  * $Revision: 1.6 $
  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_XSheetCellRangeContainer_idl__
  32 #define __com_sun_star_sheet_XSheetCellRangeContainer_idl__
  33
  34 #ifndef __com_sun_star_sheet_XSheetCellRanges_idl__
  35 #include <com/sun/star/sheet/XSheetCellRanges.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_container_NoSuchElementException_idl__
  43 #include <com/sun/star/container/NoSuchElementException.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** provides methods to access cell ranges in a collection via index and
  53     to add and remove cell ranges.
  54
  55     @see com::sun::star::sheet::SheetCellRanges
  56  */
  57 published interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** adds the given range to the collection of cell ranges.
  62
  63         @param aCellRangeAddress
  64             contains the address of the new range.
  65
  66         @param bMergeRanges
  67             defines how the range should be added. To merge the ranges
  68             takes more time, but the memory usage is lower.
  69      */
  70     void addRangeAddress(
  71             [in] com::sun::star::table::CellRangeAddress aCellRangeAddress,
  72             [in] boolean bMergeRanges );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** removes the given range from the collection of cell ranges.
  77
  78         @param aCellRangeAddress
  79             contains the address of the range to be removed.
  80
  81             <p>The specified range must fit exactly to an element of the
  82             collection. The method does not try to shorten a range.</p>
  83
  84         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
  85             if the collection does not contain the specified range.
  86      */
  87     void removeRangeAddress(
  88             [in] com::sun::star::table::CellRangeAddress aCellRangeAddress )
  89         raises( com::sun::star::container::NoSuchElementException );
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** adds the given ranges to the collection of cell ranges.
  94
  95         @param aCellRangeAddresses
  96             contains a sequence of addresses of all new ranges.
  97
  98         @param bMergeRanges
  99             defines how the ranges should be added. To merge the ranges
 100             takes more time, but the memory usage is lower.
 101      */
 102     void addRangeAddresses(
 103             [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses,
 104             [in] boolean bMergeRanges );
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** removes the given ranges from the collection of cell ranges.
 109
 110         @param aCellRangeAddresses
 111             contains a sequence of addresses of all ranges to be removed.
 112
 113             <p>All specified ranges must fit exactly to elements of the
 114             collection. The method does not try to shorten ranges.</p>
 115
 116         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
 117             if the collection does not contain any of the specified ranges.
 118      */
 119     void removeRangeAddresses(
 120             [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses )
 121         raises( com::sun::star::container::NoSuchElementException);
 122
 123 };
 124
 125 //=============================================================================
 126
 127 }; }; }; };
 128
 129 #endif
 130