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

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