xref: /aoo41x/main/offapi/com/sun/star/util/XModeSelector.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_util_XModeSelector_idl__
#define __com_sun_star_util_XModeSelector_idl__

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

#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module util {

//=============================================================================

/** is supported by objects which supply different modes.
 */
published interface XModeSelector: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** sets a new mode for the implementing object.
	 */
	void setMode( [in] string aMode )
			raises( com::sun::star::lang::NoSupportException );

	//-------------------------------------------------------------------------
	/** @returns
					the current mode.
	 */
	string getMode();

	//-------------------------------------------------------------------------
	/** @returns
					a sequence of all supported modes.
	 */
	sequence<string> getSupportedModes();

	//-------------------------------------------------------------------------
	/** asks whether a mode is supported or not.
	 */
	boolean supportsMode( [in] string aMode );

};

//=============================================================================

}; }; }; };

#endif