xref: /AOO41X/main/offapi/com/sun/star/sheet/XSheetFilterableEx.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#ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__
24#define __com_sun_star_sheet_XSheetFilterableEx_idl__
25
26#ifndef __com_sun_star_sheet_XSheetFilterable_idl__
27#include <com/sun/star/sheet/XSheetFilterable.idl>
28#endif
29
30#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
31#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** represents something from which criteria for filtering can be read.
42
43    <p>In general the current object will be used only to create the
44    descriptor to filter another object, i.e. the advanced filter feature
45    in a spreadsheet.</p>
46
47    @see com::sun::star::sheet::SheetCellRange
48 */
49published interface XSheetFilterableEx: com::sun::star::sheet::XSheetFilterable
50{
51    //-------------------------------------------------------------------------
52
53    /** creates a filter descriptor for the specified filterable object from
54        the contents of this object.
55     */
56    com::sun::star::sheet::XSheetFilterDescriptor
57        createFilterDescriptorByObject(
58            [in] com::sun::star::sheet::XSheetFilterable xObject );
59
60};
61
62//=============================================================================
63
64}; }; }; };
65
66#endif
67
68