1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_SheetFilterDescriptor_idl__
25#define __com_sun_star_sheet_SheetFilterDescriptor_idl__
26
27#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
28#include <com/sun/star/sheet/XSheetFilterDescriptor2.idl>
29#include <com/sun/star/beans/XPropertySet.idl>
30#include <com/sun/star/table/TableOrientation.idl>
31#include <com/sun/star/table/CellAddress.idl>
32
33//=============================================================================
34
35module com {  module sun {  module star {  module sheet {
36
37//=============================================================================
38
39/** represents a description of how a cell range is to be filtered.
40
41	<p>The descriptor contains properties and a collection of filter
42	conditions (filter fields) which control the behaviour of a filter
43	operation.</p>
44 */
45published service SheetFilterDescriptor
46{
47	//-------------------------------------------------------------------------
48
49	/** provides access to the collection of filter fields.
50	 */
51	interface XSheetFilterDescriptor;
52
53	//-------------------------------------------------------------------------
54
55	/** provides access to the collection of filter fields.
56
57        <p>This interface provides a sequence of <type>TableFilterField2</type>
58        structures supporting a wider range of comparison operators, compared
59        to the <type>TableFilterField</type> structure provided by interface
60        <type>XSheetFilterDescriptor</type>.
61
62        @since OpenOffice 3.2
63	 */
64	[optional] interface XSheetFilterDescriptor2;
65
66	//-------------------------------------------------------------------------
67
68//!published service PropertySet
69	/** provides access to the properties.
70	 */
71	interface com::sun::star::beans::XPropertySet;
72
73	//=========================================================================
74
75	/** specifies if the case of letters is important when comparing entries.
76	 */
77	[property] boolean IsCaseSensitive;
78
79	//-------------------------------------------------------------------------
80
81	/** specifies if duplicate entries are left out of the result.
82	 */
83	[property] boolean SkipDuplicates;
84
85	//-------------------------------------------------------------------------
86
87	/** specifies if the <member>TableFilterField::StringValue</member>
88		strings are interpreted as regular expressions.
89	 */
90	[property] boolean UseRegularExpressions;
91
92	//-------------------------------------------------------------------------
93
94	/** specifies if the <member>SheetFilterDescriptor::OutputPosition</member>
95		position is saved for future calls.
96
97		<p>This is only used if
98		<member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p>
99	 */
100	[property] boolean SaveOutputPosition;
101
102	//-------------------------------------------------------------------------
103
104	/** specifies if columns or rows are filtered.
105	 */
106	[property] com::sun::star::table::TableOrientation Orientation;
107
108	//-------------------------------------------------------------------------
109
110	/** specifies if the first row (or column) contains headers which should
111		not be filtered.
112	 */
113	[property] boolean ContainsHeader;
114
115	//-------------------------------------------------------------------------
116
117	/** specifies if the filtered data should be copied to another position
118		in the document.
119	 */
120	[property] boolean CopyOutputData;
121
122	//-------------------------------------------------------------------------
123
124	/** specifies the position where filtered data are to be copied.
125
126		<p>This is only used if
127		<member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p>
128	 */
129	[property] com::sun::star::table::CellAddress OutputPosition;
130
131	//-------------------------------------------------------------------------
132
133	/** returns the maximum number of filter fields in the descriptor.
134
135		<p>This read-only property indicates the maximum count of fields the
136		current implementation supports.</p>
137	 */
138	[readonly, property] long MaxFieldCount;
139
140};
141
142//=============================================================================
143
144}; }; }; };
145
146#endif
147
148