/************************************************************************* * * 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 * * for a copy of the LGPLv3 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