offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__
  29 #define __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_container_XIndexAccess_idl__
  36 #include <com/sun/star/container/XIndexAccess.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** provides access to a collection of collections of equal-formatted
  46     cell ranges.
  47
  48     @see com::sun::star::sheet::SheetCellRange
  49     @see com::sun::star::sheet::SheetCellRanges
  50  */
  51 published interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface
  52 {
  53     /** returns a collection of equal-formatted cell range collections.
  54
  55         <p>Each cell of the original range is contained in one of the
  56         ranges (even unformatted cells). If there is a non-rectangular
  57         equal-formatted cell area, it will be split into several
  58         rectangular ranges.</p>
  59
  60         <p>All equal-formatted ranges are consolidated into one collection.
  61         These collections are the members contained in a
  62         <type>UniqueCellFormatRanges</type> collection.</p>
  63
  64         @returns
  65             the collection of equal-formatted cell range collections.
  66
  67         @see com::sun::star::sheet::UniqueCellFormatRanges
  68      */
  69     com::sun::star::container::XIndexAccess getUniqueCellFormatRanges();
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif
  77