summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl
blob: fc8392cf7b073040ca2fcac72787aaa36ee2f123 (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
/*************************************************************************
 *
 *  $RCSfile: SheetFilterDescriptor.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:16:58 $
 *
 *  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_SheetFilterDescriptor_idl__
#define __com_sun_star_sheet_SheetFilterDescriptor_idl__

#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

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

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

// DocMerge from xml: service com::sun::star::sheet::SheetFilterDescriptor
/** a description of how a cell range is to be filtered.
 */
service SheetFilterDescriptor
{
    // DocMerge: empty anyway
    interface com::sun::star::sheet::XSheetFilterDescriptor;

    // DocMerge: empty anyway
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::IsCaseSensitive

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::IsCaseSensitive
    /** specifies if the case of letters is important when comparing entries.
     */
    [property] boolean IsCaseSensitive;

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::SkipDuplicates

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::SkipDuplicates
    /** specifies if duplicate entries are left out of the result.
     */
    [property] boolean SkipDuplicates;

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::UseRegularExpressions

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::UseRegularExpressions
    /** specifies if the <member>TableFilterField::StringValue</member>
        strings are interpreted as regular expressions.
     */
    [property] boolean UseRegularExpressions;

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::SaveOutputPosition

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::SaveOutputPosition
    /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member> position is saved
        for future calls.



        <p>This is only used if <member>SheetFilterDescriptor::CopyOutputData</member> is <true></true>.</p>
     */
    [property] boolean SaveOutputPosition;

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

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::Orientation
    /** specifies if columns or rows are filtered.
     */
    [property] com::sun::star::table::TableOrientation Orientation;

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

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::ContainsHeader
    /** specifies if the first row (or column)
        contains headers which should not be filtered.
     */
    [property] boolean ContainsHeader;

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

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::CopyOutputData
    /** specifies if the filtered data should
        be copied to another position in the document.
     */
    [property] boolean CopyOutputData;

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

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::OutputPosition
    /** specifies the position where filtered data
        are to be copied.



        <p>This is only used if <member>SheetFilterDescriptor::CopyOutputData</member> is <true></true>.</p>
     */
    [property] com::sun::star::table::CellAddress OutputPosition;

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

    // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::MaxFieldCount
    /** returns the maximum number of filter fields
        in the descriptor.
     */
    [readonly, property] long MaxFieldCount;

};

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

}; }; }; };

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

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:48  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:49  mi
    documentation merged from XML

    Revision 1.3  2000/03/24 17:35:23  nn
    #74032# documentation added

    Revision 1.2  2000/02/07 11:24:54  mi
    zu #70728# missing documentation marked

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


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