xref: /AOO41X/main/offapi/com/sun/star/sheet/TableFilterField.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_TableFilterField_idl__
25#define __com_sun_star_sheet_TableFilterField_idl__
26
27#include <com/sun/star/sheet/FilterConnection.idl>
28#include <com/sun/star/sheet/FilterOperator.idl>
29
30//=============================================================================
31
32module com {  module sun {  module star {  module sheet {
33
34//=============================================================================
35
36/** describes a single condition in a filter descriptor.
37
38    @see SheetFilterDescriptor
39 */
40published struct TableFilterField
41{
42    //-------------------------------------------------------------------------
43
44    /** specifies how the condition is connected to the previous condition.
45     */
46    FilterConnection Connection;
47
48    //-------------------------------------------------------------------------
49
50    /** specifies which field (column) is used for the condition.
51     */
52    long Field;
53
54    //-------------------------------------------------------------------------
55
56    /** specifies the type of the condition.
57     */
58    FilterOperator Operator;
59
60    //-------------------------------------------------------------------------
61
62    /** selects whether the <member>TableFilterField::NumericValue</member>
63        or the <member>TableFilterField::StringValue</member> is used.
64     */
65    boolean IsNumeric;
66
67    //-------------------------------------------------------------------------
68
69    /** specifies a numeric value for the condition.
70     */
71    double NumericValue;
72
73    //-------------------------------------------------------------------------
74
75    /** specifies a string value for the condition.
76     */
77    string StringValue;
78
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86
87