xref: /AOO41X/main/offapi/com/sun/star/sheet/XSheetFilterable.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_XSheetFilterable_idl__
25#define __com_sun_star_sheet_XSheetFilterable_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
32#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** represents something that can be filtered using an XSheetFilterDesriptor.
42
43    @see com::sun::star::sheet::XSheetFilterableEx
44 */
45published interface XSheetFilterable: com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48
49    /** creates a filter descriptor.
50
51        @param bEmpty
52            if set to <TRUE/>, creates an empty filter descriptor. If set to
53            <FALSE/>, fills the filter descriptor with previous settings of
54            the current object (i.e. a database range).
55     */
56    com::sun::star::sheet::XSheetFilterDescriptor
57        createFilterDescriptor( [in] boolean bEmpty );
58
59    //-------------------------------------------------------------------------
60
61    /** performa a filter operation, using the settings of the passed filter
62        descriptor.
63
64        @param xDescriptor
65            the settings for the filter operation.
66     */
67    void filter(
68            [in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor );
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77
78