summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl
blob: 1905302da63553b437772782625ad1baf50e0d18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XUniqueCellFormatRangesSupplier.idl,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__
#define __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

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

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

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

/** provides access to a collection of collections of equal-formatted
    cell ranges.

    @see com::sun::star::sheet::SheetCellRange
    @see com::sun::star::sheet::SheetCellRanges
 */
published interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface
{
    /** returns a collection of equal-formatted cell range collections.

        <p>Each cell of the original range is contained in one of the
        ranges (even unformatted cells). If there is a non-rectangular
        equal-formatted cell area, it will be split into several
        rectangular ranges.</p>

        <p>All equal-formatted ranges are consolidated into one collection.
        These collections are the members contained in a
        <type>UniqueCellFormatRanges</type> collection.</p>

        @returns
            the collection of equal-formatted cell range collections.

        @see com::sun::star::sheet::UniqueCellFormatRanges
     */
    com::sun::star::container::XIndexAccess getUniqueCellFormatRanges();
};

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

}; }; }; };

#endif