AOO410/main/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#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 <type>FilePicker</type> service.
*/
published 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 );
};

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