LibreOffice LibreOffice 25.2 SDK API Reference

SheetFilterDescriptor.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module sheet {
22
23
30published service SheetFilterDescriptor
31{
32
35 interface XSheetFilterDescriptor;
36
37
47 [optional] interface XSheetFilterDescriptor2;
48
49
51
53 interface com::sun::star::beans::XPropertySet;
54
55
58 [property] boolean IsCaseSensitive;
59
60
63 [property] boolean SkipDuplicates;
64
65
69 [property] boolean UseRegularExpressions;
70
71
78 [property] boolean SaveOutputPosition;
79
80
83 [property] com::sun::star::table::TableOrientation Orientation;
84
85
89 [property] boolean ContainsHeader;
90
91
95 [property] boolean CopyOutputData;
96
97
103 [property] com::sun::star::table::CellAddress OutputPosition;
104
105
111 [readonly, property] long MaxFieldCount;
112
113};
114
115
116}; }; }; };
117
118/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::sheet::XSheetFilterDescriptor2
provides access to a collection of filter conditions (filter fields).
Definition: XSheetFilterDescriptor2.idl:34
com::sun::star::sheet::XSheetFilterDescriptor
provides access to a collection of filter conditions (filter fields).
Definition: XSheetFilterDescriptor.idl:29
com::sun::star::table::TableOrientation
TableOrientation
used to select whether operations are carried out on columns or rows.
Definition: TableOrientation.idl:27
com
Definition: Ambiguous.idl:20
com::sun::star::sheet::SheetFilterDescriptor
represents a description of how a cell range is to be filtered.
Definition: SheetFilterDescriptor.idl:31
com::sun::star::sheet::SheetFilterDescriptor::CopyOutputData
boolean CopyOutputData
specifies if the filtered data should be copied to another position in the document.
Definition: SheetFilterDescriptor.idl:95
com::sun::star::sheet::SheetFilterDescriptor::MaxFieldCount
long MaxFieldCount
returns the maximum number of filter fields in the descriptor.
Definition: SheetFilterDescriptor.idl:111
com::sun::star::sheet::SheetFilterDescriptor::SaveOutputPosition
boolean SaveOutputPosition
specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls.
Definition: SheetFilterDescriptor.idl:78
com::sun::star::sheet::SheetFilterDescriptor::ContainsHeader
boolean ContainsHeader
specifies if the first row (or column) contains headers which should not be filtered.
Definition: SheetFilterDescriptor.idl:89
com::sun::star::sheet::SheetFilterDescriptor::IsCaseSensitive
boolean IsCaseSensitive
specifies if the case of letters is important when comparing entries.
Definition: SheetFilterDescriptor.idl:53
com::sun::star::sheet::SheetFilterDescriptor::SkipDuplicates
boolean SkipDuplicates
specifies if duplicate entries are left out of the result.
Definition: SheetFilterDescriptor.idl:63
com::sun::star::sheet::SheetFilterDescriptor::OutputPosition
com::sun::star::table::CellAddress OutputPosition
specifies the position where filtered data are to be copied.
Definition: SheetFilterDescriptor.idl:103
com::sun::star::sheet::SheetFilterDescriptor::Orientation
com::sun::star::table::TableOrientation Orientation
specifies if columns or rows are filtered.
Definition: SheetFilterDescriptor.idl:83
com::sun::star::sheet::SheetFilterDescriptor::UseRegularExpressions
boolean UseRegularExpressions
specifies if the TableFilterField::StringValue strings are interpreted as regular expressions.
Definition: SheetFilterDescriptor.idl:69
com::sun::star::table::CellAddress
contains a cell address within a spreadsheet document.
Definition: CellAddress.idl:27