/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XFilterManager.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:40:30 $
 *
 *  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_ui_dialogs_XFilterManager_idl__
#define __com_sun_star_ui_dialogs_XFilterManager_idl__

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

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

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

module com { module sun { module star { module ui { module dialogs {

//=============================================================================
/** Specifies a filter manager interface for a FilePicker
*/

published interface XFilterManager: com::sun::star::uno::XInterface
{

    //-------------------------------------------------------------------------
    /** Adds a filter identified by a title.

        @param aTitle
        Specifies the name of the filter as shown in the filter box of the
        FilePicker dialog.

        @param aFilter
        Specifies the extensions of the filter. Multiple filters should be
        semicolon separated. The semicolon may not be used as character in
        a filter expresion. A typical filter is for instance '*.txt'.

        @throws ::com::sun::star::lang::IllegalArgumentException
        If a filter with the specified title already exists.

    */
    void appendFilter( [in] string aTitle, [in] string aFilter )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** Sets the current filter.

        @param aTitle
        Specifies the name of the filter to be set.

        @throws com::sun::star::lang::IllegalArgumentException
        If the specified filter was not found.
    */
    void setCurrentFilter( [in] string aTitle )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** Returns the currently selected filter.

        @returns
        The the name of the selected filter or an empty string if
        there is no filter or no filter is currently selected.
    */
    string getCurrentFilter( );
};

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

}; }; }; }; };


#endif

