/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SheetFilterDescriptor.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 04:49:59 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#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

