xref: /aoo42x/main/udkapi/com/sun/star/script/XScriptEventsAttacher.idl (revision 408a4873)

/**************************************************************
 *
 * 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_XScriptEventsAttacher_idl__
#define __com_sun_star_script_XScriptEventsAttacher_idl__

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

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_beans_IntrospectionException_idl__
#include <com/sun/star/beans/IntrospectionException.idl>
#endif

#ifndef __com_sun_star_script_CannotCreateAdapterException_idl__
#include <com/sun/star/script/CannotCreateAdapterException.idl>
#endif

#ifndef __com_sun_star_lang_ServiceNotRegisteredException_idl__
#include <com/sun/star/lang/ServiceNotRegisteredException.idl>
#endif


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

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

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

/**
	This interface can be used to attach script events to a number of
	objects that give access to the definition of events that should
	be attached to them, e.g., by supporting XEventsSupplier
*/
published interface XScriptEventsAttacher: com::sun::star::uno::XInterface
{
	/**
		Attaches the events defined by XScriptEventsSupplier to the
		corresponding object implementing XScriptEventsSupplier.

		@param Objects
							Sequence of all objects. Usually the objects should directly
							support <type>XScriptEventsAttacher</type> to define the events
							but this is not strictly required. It's also possible that
							the object implementing <type>XScriptEventsAttacher</type>
							knows how to get the necessary information for the objects.
		@param xListener
							All events (if defined by XScriptEventsSupplier) that are fired
							by one of the objects are mapped into a <type>ScriptEvent</type>
							and passed to the methods of this XScriptListener.
		@param Helper
							Helper object for the implementation. This value will be
							passed to the XScriptListener as Helper property in the
							<type>ScriptEvent</type>.
	*/
	void attachEvents(	[in] sequence< com::sun::star::uno::XInterface > Objects,
						[in] com::sun::star::script::XScriptListener xListener,
						[in] any Helper )
			raises( com::sun::star::lang::IllegalArgumentException,
					com::sun::star::beans::IntrospectionException,
					com::sun::star::script::CannotCreateAdapterException,
					com::sun::star::lang::ServiceNotRegisteredException );

};

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

}; }; }; };

#endif