summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl
blob: fb8a3d43da95fa9f355e3f4de05a79cea6249ffd (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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*************************************************************************
 *
 *  $RCSfile: XConsolidationDescriptor.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: obo $ $Date: 2004-06-03 23:02:30 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__
#define __com_sun_star_sheet_XConsolidationDescriptor_idl__

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

#ifndef __com_sun_star_sheet_GeneralFunction_idl__
#include <com/sun/star/sheet/GeneralFunction.idl>
#endif

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

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

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

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

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

/** provides access to the settings of a consolidation descriptor.

    @deprecated

    @see com::sun::star::sheet::ConsolidationDescriptor
 */
published interface XConsolidationDescriptor: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the function by which the ranges are consolidated.
     */
    com::sun::star::sheet::GeneralFunction getFunction();

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

    /** sets the function by which the ranges are consolidated.
     */
    void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction );

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

    /** returns the cell ranges which are consolidated.
     */
    sequence< com::sun::star::table::CellRangeAddress > getSources();

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

    /** sets the cell ranges which are consolidated.
     */
    void setSources(
            [in] sequence< com::sun::star::table::CellRangeAddress > aSources );

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

    /** returns the position of the top left cell of the cell range where
        the consolidated data are copied.
     */
    com::sun::star::table::CellAddress getStartOutputPosition();

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

    /** sets the position of the top left cell of the cell range
        where the consolidated data are copied.
     */
    void setStartOutputPosition(
            [in] com::sun::star::table::CellAddress aStartOutputPosition );

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

    /** returns, whether column headers from the cell ranges are used to
        find matching data or not.
     */
    boolean getUseColumnHeaders();

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

    /** specifies if column headers from the cell ranges are used to find
        matching data.
     */
    void setUseColumnHeaders( [in] boolean bUseColumnHeaders );

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

    /** returns, whether row headers from the cell ranges are used to
        find matching data or not.
     */
    boolean getUseRowHeaders();

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

    /** specifies if row headers from the cell ranges are used to find
        matching data.
     */
    void setUseRowHeaders( [in] boolean bUseRowHeaders );

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

    /** returns, whether links to the original data are inserted in the
        output area or not.
     */
    boolean getInsertLinks();

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

    /** specifies if links to the original data are inserted in the
        output area.
     */
    void setInsertLinks( [in] boolean bInsertLinks );

};

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

}; }; }; };

#endif