1 files changed, 148 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl
new file mode 100644
index 000000000000..8e94a6b2edcf
--- /dev/null
+++ b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl
@@ -0,0 +1,148 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_sheet_SheetFilterDescriptor_idl__
+#define __com_sun_star_sheet_SheetFilterDescriptor_idl__
+
+#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
+#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+
+#ifndef __com_sun_star_table_TableOrientation_idl__
+#include <com/sun/star/table/TableOrientation.idl>
+#endif
+
+#ifndef __com_sun_star_table_CellAddress_idl__
+#include <com/sun/star/table/CellAddress.idl>
+#endif
+
+//=============================================================================
+
+module com {  module sun {  module star {  module sheet {
+
+//=============================================================================
+
+/** represents a description of how a cell range is to be filtered.
+
+    <p>The descriptor contains properties and a collection of filter
+    conditions (filter fields) which control the behaviour of a filter
+    operation.</p>
+ */
+published service SheetFilterDescriptor
+{
+    //-------------------------------------------------------------------------
+
+    /** provides access to the collection of filter fields.
+     */
+    interface com::sun::star::sheet::XSheetFilterDescriptor;
+
+    //-------------------------------------------------------------------------
+
+//!published service PropertySet
+    /** provides access to the properties.
+     */
+    interface com::sun::star::beans::XPropertySet;
+
+    //=========================================================================
+
+    /** specifies if the case of letters is important when comparing entries.
+     */
+    [property] boolean IsCaseSensitive;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies if duplicate entries are left out of the result.
+     */
+    [property] boolean SkipDuplicates;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies if the <member>TableFilterField::StringValue</member>
+        strings are interpreted as regular expressions.
+     */
+    [property] boolean UseRegularExpressions;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member>
+        position is saved for future calls.
+
+        <p>This is only used if
+        <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p>
+     */
+    [property] boolean SaveOutputPosition;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies if columns or rows are filtered.
+     */
+    [property] com::sun::star::table::TableOrientation Orientation;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies if the first row (or column) contains headers which should
+        not be filtered.
+     */
+    [property] boolean ContainsHeader;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies if the filtered data should be copied to another position
+        in the document.
+     */
+    [property] boolean CopyOutputData;
+
+    //-------------------------------------------------------------------------
+
+    /** specifies the position where filtered data are to be copied.
+
+        <p>This is only used if
+        <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p>
+     */
+    [property] com::sun::star::table::CellAddress OutputPosition;
+
+    //-------------------------------------------------------------------------
+
+    /** returns the maximum number of filter fields in the descriptor.
+
+        <p>This read-only property indicates the maximum count of fields the
+        current implementation supports.</p>
+     */
+    [readonly, property] long MaxFieldCount;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+