offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.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 access to a collection of collections of equal-formatted
  25     cell ranges.
  26
  27     @see com::sun::star::sheet::SheetCellRange
  28     @see com::sun::star::sheet::SheetCellRanges
  29  */
  30 published interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface
  31 {
  32     /** returns a collection of equal-formatted cell range collections.
  33
  34         <p>Each cell of the original range is contained in one of the
  35         ranges (even unformatted cells). If there is a non-rectangular
  36         equal-formatted cell area, it will be split into several
  37         rectangular ranges.</p>
  38
  39         <p>All equal-formatted ranges are consolidated into one collection.
  40         These collections are the members contained in a
  41         UniqueCellFormatRanges collection.</p>
  42
  43         @returns
  44             the collection of equal-formatted cell range collections.
  45
  46         @see com::sun::star::sheet::UniqueCellFormatRanges
  47      */
  48     com::sun::star::container::XIndexAccess getUniqueCellFormatRanges();
  49 };
  50
  51
  52 }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */