1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_uno_XInterface_idl__
25#include <com/sun/star/uno/XInterface.idl>
26#endif
27
28#ifndef __com_sun_star_beans_StringPair_idl__
29#include <com/sun/star/beans/StringPair.idl>
30#endif
31
32#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
33#include <com/sun/star/lang/IllegalArgumentException.idl>
34#endif
35
36module com {  module sun {  module star {  module ui { module dialogs {
37
38//=============================================================================
39/** Specifies an interface which allows manipulation of groups of filters
40	for the <type>FilePicker</type> service.
41*/
42published interface XFilterGroupManager : com::sun::star::uno::XInterface
43{
44	/** Appends a group of filters to the current filter list.
45
46		<p>It is implementation dependent how the filter groups are presented to the user.<br/>
47		It is not even guaranteed that the groups are visualized: implementations are free to simply
48		append all the filters separately, with ignoring the group title.</p>
49
50	@param sGroupTitle
51		The title of the filter group. Usually, the caller should localize this title, as it is to be presented to
52		the user.
53
54	@param aFilters
55		The filters which form a group. Every filter consists of two strings, where the first one is a display name
56		(as for <arg>sGroupTitle</arg>, it holds that these strings should be localized), and the second one the
57		semicolon separated list of wildcard expressions for the filter.<br/>
58		Usually, the expressions are simply extensions (e.g. "*.txt"), but this must no necessarily be the case.
59
60	@throws com::sun::star::lang::IllegalArgumentException
61	if one or more filters in the given filter list already exist.
62
63	@see com::sun::star::ui::dialogs::XFilterManager
64	@see com::sun::star::ui::dialogs::FilePicker
65	*/
66	void appendFilterGroup(
67		[in] string sGroupTitle,
68		[in] sequence< com::sun::star::beans::StringPair > aFilters
69	)
70	raises( com::sun::star::lang::IllegalArgumentException );
71};
72
73//.............................................................................
74}; }; }; }; };
75//.............................................................................
76
77