/************************************************************** * * 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_XEventAttacher_idl__ #define __com_sun_star_script_XEventAttacher_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_lang_XEventListener_idl__ #include #endif #ifndef __com_sun_star_script_XAllListener_idl__ #include #endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include #endif #ifndef __com_sun_star_beans_IntrospectionException_idl__ #include #endif #ifndef __com_sun_star_script_CannotCreateAdapterException_idl__ #include #endif #ifndef __com_sun_star_lang_ServiceNotRegisteredException_idl__ #include #endif //============================================================================= module com { module sun { module star { module script { //============================================================================= /** makes it possible to attach script events given by a sequence of ScriptEventDescriptor structures to a given interface. */ published interface XEventAttacher: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** registers the given "AllListener" object as a listener at the given interface by creating a suitable listener adapter and calling the "addListener" method corresponding to the "ListenerType". */ com::sun::star::lang::XEventListener attachListener( [in] com::sun::star::uno::XInterface xTarget, [in] com::sun::star::script::XAllListener xAllListener, [in] any aHelper, [in] string aListenerType, [in] string aAddListenerParam ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::IntrospectionException, com::sun::star::script::CannotCreateAdapterException, com::sun::star::lang::ServiceNotRegisteredException ); //------------------------------------------------------------------------- /** registers an object as a listener at the given interface by creating a suitable listener adapter and calling the method which corresponds to the listener type.

Only the event corresponding to the given event method will be delegated to xAllListener.

*/ com::sun::star::lang::XEventListener attachSingleEventListener( [in] com::sun::star::uno::XInterface xTarget, [in] com::sun::star::script::XAllListener xAllListener, [in] any aHelper, [in] string aListenerType, [in] string aAddListenerParam, [in] string aEventMethod ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::IntrospectionException, com::sun::star::script::CannotCreateAdapterException, com::sun::star::lang::ServiceNotRegisteredException ); //------------------------------------------------------------------------- /** removes a listener object as a listener from the given interface.

This method can and should be used as a contrary method to the two attach methods.

*/ void removeListener( [in] com::sun::star::uno::XInterface xTarget, [in] string aListenerType, [in] string aRemoveListenerParam, [in] com::sun::star::lang::XEventListener xToRemoveListener ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::IntrospectionException ); }; //============================================================================= }; }; }; }; #endif