summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XCellRangesQuery.idl
blob: 3e5bd23819e208dff7978cc2d56cb2fd1f537029 (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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*************************************************************************
 *
 *  $RCSfile: XCellRangesQuery.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $
 *
 *  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_XCellRangesQuery_idl__
#define __com_sun_star_sheet_XCellRangesQuery_idl__

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

#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__
#include <com/sun/star/sheet/XSheetCellRanges.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.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 {

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

// DocMerge from xml: interface com::sun::star::sheet::XCellRangesQuery
/** provides methods to invoke queries on cells.@see service com::sun::star::sheet::SheetRangesQuery
 */
[ uik(E2281511-33D6-11D1-AABE00A0-249D5590), ident( "XCellRangesQuery", 1.0 ) ]
interface XCellRangesQuery: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryVisibleCells
    /** points the cursor to only the visible (not hidden)
        cells of those to which it currently points.
     */
    com::sun::star::sheet::XSheetCellRanges queryVisibleCells();

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

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryEmptyCells
    /** collapses the cursor to the empty cells within the range to which it is currently pointing.



        <p>After this operation the cursor only contains the empty cells
        out of those which it pointed before.</p>
     */
    com::sun::star::sheet::XSheetCellRanges queryEmptyCells();

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

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryContentCells
    /** collapses the cursor to the cells with the specified content type
        within the range to which it is currently pointing.



        <p>After this operation, the cursor only contains cells with the specified
        content type out of those which it pointed before.

        </p>
     */
    com::sun::star::sheet::XSheetCellRanges queryContentCells( [in] short nContentFlags );

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

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryFormulaCells
    /** queries all cells with a specified result type.



        <p>The set of cells to which the cursor is currently pointing
        will be collapsed into a subset. This subset is specified by the
        formula cells containing results of a specified type</p>.
     */
    com::sun::star::sheet::XSheetCellRanges queryFormulaCells( [in] long nResultFlags );

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

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryColumnDifferences
    /** queries all cells which have a different value in
        a specified row.



        <p>The set of cells to which the cursor is currently pointing
        will be collapsed into a subset. This subset is specified by all
        cells which have a different value in the same column of the
        specified row.</p>
     */
    com::sun::star::sheet::XSheetCellRanges queryColumnDifferences( [in] com::sun::star::table::CellAddress aCompare );

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

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryRowDifferences
    /** queries all cells which have a different value in
        a specified column.



        <p>The set of cells to which the cursor is currently pointing
        will be collapsed into a subset. This subset is specified by all
        cells which have a different value in the same row of the
        specified column.</p>
     */
    com::sun::star::sheet::XSheetCellRanges queryRowDifferences( [in] com::sun::star::table::CellAddress aCompare );

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

    // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryIntersection
    /** intersects the cursor with the specified cell range.



        <p>The set of cells to which the cursor is currently pointing
        will be collapsed into a subset. This subset is specified by all
        cells which are also in the specified range.</p>
     */
    com::sun::star::sheet::XSheetCellRanges queryIntersection( [in] com::sun::star::table::CellRangeAddress aRange );

};

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

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.2  2000/10/09 14:24:58  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)

    Revision 1.1.1.1  2000/09/18 23:35:49  hjs
    initial import

    Revision 1.4  2000/09/11 11:52:50  mi
    documentation merged from XML

    Revision 1.2  1999/11/25 16:03:33  mi
    welforming HTML for XML

    Revision 1.1.1.1  1999/11/11 09:48:45  jsc
    new


=============================================================================*/
#endif