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#ifndef __com_sun_star_util_XModeSelector_idl__
24#define __com_sun_star_util_XModeSelector_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_NoSupportException_idl__
31#include <com/sun/star/lang/NoSupportException.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module util {
38
39//=============================================================================
40
41/** is supported by objects which supply different modes.
42 */
43published interface XModeSelector: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46	/** sets a new mode for the implementing object.
47	 */
48	void setMode( [in] string aMode )
49			raises( com::sun::star::lang::NoSupportException );
50
51	//-------------------------------------------------------------------------
52	/** @returns
53					the current mode.
54	 */
55	string getMode();
56
57	//-------------------------------------------------------------------------
58	/** @returns
59					a sequence of all supported modes.
60	 */
61	sequence<string> getSupportedModes();
62
63	//-------------------------------------------------------------------------
64	/** asks whether a mode is supported or not.
65	 */
66	boolean supportsMode( [in] string aMode );
67
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75