offapi/com/sun/star/sheet/XSheetCellRanges.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: XSheetCellRanges.idl,v $
  10  * $Revision: 1.9 $
  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_XSheetCellRanges_idl__
  32 #define __com_sun_star_sheet_XSheetCellRanges_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  39 #include <com/sun/star/container/XEnumerationAccess.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  43 #include <com/sun/star/table/CellRangeAddress.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     other helper methods.
  54
  55     @see com::sun::star::sheet::SheetCellRanges
  56  */
  57 published interface XSheetCellRanges: com::sun::star::container::XIndexAccess
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** returns the collection of all used cells.
  62
  63         @see com::sun::star::sheet::Cells
  64      */
  65     com::sun::star::container::XEnumerationAccess getCells();
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** creates a string with addresses of all contained cell ranges.
  70
  71         <p>The range addresses are separated with semicolons. For instance
  72         the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p>
  73
  74         @returns
  75             a string containing the addresses of all cell ranges.
  76      */
  77     string getRangeAddressesAsString();
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** creates a sequence with addresses of all contained cell ranges.
  82
  83         @returns
  84             a sequence with the addresses of all cell ranges.
  85      */
  86     sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses();
  87
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif
  95