/*************************************************************************
 *
 *  $RCSfile: XFilterGroupManager.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: hr $ $Date: 2003/03/26 13:58:05 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

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

#ifndef __com_sun_star_beans_StringPair_idl__
#include <com/sun/star/beans/StringPair.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 an interface which allows manipulation of groups of filters 
	for the <service>FilePicker</service> service.
*/
interface XFilterGroupManager : com::sun::star::uno::XInterface
{
	/** Appends a group of filters to the current filter list.

		<p>It is implementation dependent how the filter groups are presented to the user.<br/>
		It is not even guaranteed that the groups are visualized: implementations are free to simply
		append all the filters separately, with ignoring the group title.</p>

	@param sGroupTitle
		The title of the filter group. Usually, the caller should localize this title, as it is to be presented to
		the user.

	@param aFilters
		The filters which form a group. Every filter consists of two strings, where the first one is a display name
		(as for <arg>sGroupTitle</arg>, it holds that these strings should be localized), and the second one the
		semicolon separated list of wildcard expressions for the filter.<br/>
		Usually, the expressions are simply extensions (e.g. "*.txt"), but this must no necessarily be the case.

	@throws com::sun::star::lang::IllegalArgumentException
	if one or more filters in the given filter list already exist.

	@see com::sun::star::ui::dialogs::XFilterManager
	@see com::sun::star::ui::dialogs::FilePicker
	*/
	void appendFilterGroup(
		[in] string sGroupTitle,
		[in] sequence< com::sun::star::beans::StringPair > aFilters
	)
	raises( com::sun::star::lang::IllegalArgumentException );
};

//.............................................................................
}; }; }; }; };
//.............................................................................

