udkapi/com/sun/star/script/XScriptEventsAttacher.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XScriptEventsAttacher.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_XScriptEventsAttacher_idl__
  31 #define __com_sun_star_script_XScriptEventsAttacher_idl__
  32
  33 #ifndef __com_sun_star_script_XScriptListener_idl__
  34 #include <com/sun/star/script/XScriptListener.idl>
  35 #endif
  36 #ifndef __com_sun_star_uno_XInterface_idl__
  37 #include <com/sun/star/uno/XInterface.idl>
  38 #endif
  39
  40 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  41 #include <com/sun/star/lang/IllegalArgumentException.idl>
  42 #endif
  43
  44 #ifndef __com_sun_star_beans_IntrospectionException_idl__
  45 #include <com/sun/star/beans/IntrospectionException.idl>
  46 #endif
  47
  48 #ifndef __com_sun_star_script_CannotCreateAdapterException_idl__
  49 #include <com/sun/star/script/CannotCreateAdapterException.idl>
  50 #endif
  51
  52 #ifndef __com_sun_star_lang_ServiceNotRegisteredException_idl__
  53 #include <com/sun/star/lang/ServiceNotRegisteredException.idl>
  54 #endif
  55
  56
  57 //=============================================================================
  58
  59  module com {  module sun {  module star {  module script {
  60
  61 //=============================================================================
  62
  63 /**
  64     This interface can be used to attach script events to a number of
  65     objects that give access to the definition of events that should
  66     be attached to them, e.g., by supporting XEventsSupplier
  67 */
  68 published interface XScriptEventsAttacher: com::sun::star::uno::XInterface
  69 {
  70     /**
  71         Attaches the events defined by XScriptEventsSupplier to the
  72         corresponding object implementing XScriptEventsSupplier.
  73
  74         @param Objects
  75                             Sequence of all objects. Usually the objects should directly
  76                             support <type>XScriptEventsAttacher</type> to define the events
  77                             but this is not strictly required. It's also possible that
  78                             the object implementing <type>XScriptEventsAttacher</type>
  79                             knows how to get the necessary information for the objects.
  80         @param xListener
  81                             All events (if defined by XScriptEventsSupplier) that are fired
  82                             by one of the objects are mapped into a <type>ScriptEvent</type>
  83                             and passed to the methods of this XScriptListener.
  84         @param Helper
  85                             Helper object for the implementation. This value will be
  86                             passed to the XScriptListener as Helper property in the
  87                             <type>ScriptEvent</type>.
  88     */
  89     void attachEvents(  [in] sequence< com::sun::star::uno::XInterface > Objects,
  90                         [in] com::sun::star::script::XScriptListener xListener,
  91                         [in] any Helper )
  92             raises( com::sun::star::lang::IllegalArgumentException,
  93                     com::sun::star::beans::IntrospectionException,
  94                     com::sun::star::script::CannotCreateAdapterException,
  95                     com::sun::star::lang::ServiceNotRegisteredException );
  96
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif
 104