xref: /aoo4110/main/udkapi/com/sun/star/script/XAllListener.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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_script_XAllListener_idl__
#define __com_sun_star_script_XAllListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_script_AllEventObject_idl__
#include <com/sun/star/script/AllEventObject.idl>
#endif

#ifndef __com_sun_star_reflection_InvocationTargetException_idl__
#include <com/sun/star/reflection/InvocationTargetException.idl>
#endif


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

 module com {  module sun {  module star {  module script {

//=============================================================================
/** specifies a listener combining all methods
	of a listener interface in a single generic call.

	<p>Without any output parameters, it is possible to adapt any interface
	if the <type>XAllListenerAdapterService</type> can generate an adapter.</p>
 */
published interface XAllListener: com::sun::star::lang::XEventListener
{
	//-------------------------------------------------------------------------
	/** gets called when an event occurs at the object.
	 */
	[oneway] void firing( [in] com::sun::star::script::AllEventObject iaEvent );

	//-------------------------------------------------------------------------
	/** gets called when a "vetoable event" occurs at the object.

		<p>That happens when the listener method raises an exception,
		has a return value declared, or is not "oneway".</p>
	 */
	any approveFiring( [in] com::sun::star::script::AllEventObject aEvent )
			raises( com::sun::star::reflection::InvocationTargetException );
};

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

}; }; }; };

#endif