/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XSheetFilterable.idl,v $
 * $Revision: 1.8 $
 *
 * 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_XSheetFilterable_idl__
#define __com_sun_star_sheet_XSheetFilterable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents something that can be filtered using an XSheetFilterDesriptor.

    @see com::sun::star::sheet::XSheetFilterableEx
 */
published interface XSheetFilterable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** creates a filter descriptor.

        @param bEmpty
            if set to <TRUE/>, creates an empty filter descriptor. If set to
            <FALSE/>, fills the filter descriptor with previous settings of
            the current object (i.e. a database range).
     */
    com::sun::star::sheet::XSheetFilterDescriptor
        createFilterDescriptor( [in] boolean bEmpty );

    //-------------------------------------------------------------------------

    /** performa a filter operation, using the settings of the passed filter
        descriptor.

        @param xDescriptor
            the settings for the filter operation.
     */
    void filter(
            [in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor );

};

//=============================================================================

}; }; }; };

#endif