xref: /AOO41X/main/offapi/com/sun/star/util/XModeSelector.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_util_XModeSelector_idl__
28#define __com_sun_star_util_XModeSelector_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_lang_NoSupportException_idl__
35#include <com/sun/star/lang/NoSupportException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module util {
42
43//=============================================================================
44
45/** is supported by objects which supply different modes.
46 */
47published interface XModeSelector: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50	/** sets a new mode for the implementing object.
51	 */
52	void setMode( [in] string aMode )
53			raises( com::sun::star::lang::NoSupportException );
54
55	//-------------------------------------------------------------------------
56	/** @returns
57					the current mode.
58	 */
59	string getMode();
60
61	//-------------------------------------------------------------------------
62	/** @returns
63					a sequence of all supported modes.
64	 */
65	sequence<string> getSupportedModes();
66
67	//-------------------------------------------------------------------------
68	/** asks whether a mode is supported or not.
69	 */
70	boolean supportsMode( [in] string aMode );
71
72};
73
74//=============================================================================
75
76}; }; }; };
77
78#endif
79