/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSheetCellRanges.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:18:40 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__
#define __com_sun_star_sheet_XSheetCellRanges_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides methods to access cell ranges in a collection via index and
    other helper methods.

    @see com::sun::star::sheet::SheetCellRanges
 */
published interface XSheetCellRanges: com::sun::star::container::XIndexAccess
{
    //-------------------------------------------------------------------------

    /** returns the collection of all used cells.

        @see com::sun::star::sheet::Cells
     */
    com::sun::star::container::XEnumerationAccess getCells();

    //-------------------------------------------------------------------------

    /** creates a string with addresses of all contained cell ranges.

        <p>The range addresses are separated with semicolons. For instance
        the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p>

        @returns
            a string containing the addresses of all cell ranges.
     */
    string getRangeAddressesAsString();

    //-------------------------------------------------------------------------

    /** creates a sequence with addresses of all contained cell ranges.

        @returns
            a sequence with the addresses of all cell ranges.
     */
    sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses();

};

//=============================================================================

}; }; }; };

#endif

