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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_script_XScriptEventsAttacher_idl__
  20 #define __com_sun_star_script_XScriptEventsAttacher_idl__
  21
  22 #include <com/sun/star/script/XScriptListener.idl>
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27 #include <com/sun/star/beans/IntrospectionException.idl>
  28
  29 #include <com/sun/star/script/CannotCreateAdapterException.idl>
  30
  31 #include <com/sun/star/lang/ServiceNotRegisteredException.idl>
  32
  33
  34
  35  module com {  module sun {  module star {  module script {
  36
  37
  38 /**
  39     This interface can be used to attach script events to a number of
  40     objects that give access to the definition of events that should
  41     be attached to them, e.g., by supporting XEventsSupplier
  42 */
  43 published interface XScriptEventsAttacher: com::sun::star::uno::XInterface
  44 {
  45     /**
  46         Attaches the events defined by XScriptEventsSupplier to the
  47         corresponding object implementing XScriptEventsSupplier.
  48
  49         @param Objects
  50                             Sequence of all objects. Usually the objects should directly
  51                             support XScriptEventsAttacher to define the events
  52                             but this is not strictly required. It's also possible that
  53                             the object implementing XScriptEventsAttacher
  54                             knows how to get the necessary information for the objects.
  55         @param xListener
  56                             All events (if defined by XScriptEventsSupplier) that are fired
  57                             by one of the objects are mapped into a ScriptEvent
  58                             and passed to the methods of this XScriptListener.
  59         @param Helper
  60                             Helper object for the implementation. This value will be
  61                             passed to the XScriptListener as Helper property in the
  62                             ScriptEvent.
  63     */
  64     void attachEvents(  [in] sequence< com::sun::star::uno::XInterface > Objects,
  65                         [in] com::sun::star::script::XScriptListener xListener,
  66                         [in] any Helper )
  67             raises( com::sun::star::lang::IllegalArgumentException,
  68                     com::sun::star::beans::IntrospectionException,
  69                     com::sun::star::script::CannotCreateAdapterException,
  70                     com::sun::star::lang::ServiceNotRegisteredException );
  71
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */