xref: /AOO41X/main/udkapi/com/sun/star/script/XScriptEventsAttacher.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_script_XScriptEventsAttacher_idl__
24#define __com_sun_star_script_XScriptEventsAttacher_idl__
25
26#ifndef __com_sun_star_script_XScriptListener_idl__
27#include <com/sun/star/script/XScriptListener.idl>
28#endif
29#ifndef __com_sun_star_uno_XInterface_idl__
30#include <com/sun/star/uno/XInterface.idl>
31#endif
32
33#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#endif
36
37#ifndef __com_sun_star_beans_IntrospectionException_idl__
38#include <com/sun/star/beans/IntrospectionException.idl>
39#endif
40
41#ifndef __com_sun_star_script_CannotCreateAdapterException_idl__
42#include <com/sun/star/script/CannotCreateAdapterException.idl>
43#endif
44
45#ifndef __com_sun_star_lang_ServiceNotRegisteredException_idl__
46#include <com/sun/star/lang/ServiceNotRegisteredException.idl>
47#endif
48
49
50//=============================================================================
51
52 module com {  module sun {  module star {  module script {
53
54//=============================================================================
55
56/**
57    This interface can be used to attach script events to a number of
58    objects that give access to the definition of events that should
59    be attached to them, e.g., by supporting XEventsSupplier
60*/
61published interface XScriptEventsAttacher: com::sun::star::uno::XInterface
62{
63    /**
64        Attaches the events defined by XScriptEventsSupplier to the
65        corresponding object implementing XScriptEventsSupplier.
66
67        @param Objects
68                            Sequence of all objects. Usually the objects should directly
69                            support <type>XScriptEventsAttacher</type> to define the events
70                            but this is not strictly required. It's also possible that
71                            the object implementing <type>XScriptEventsAttacher</type>
72                            knows how to get the necessary information for the objects.
73        @param xListener
74                            All events (if defined by XScriptEventsSupplier) that are fired
75                            by one of the objects are mapped into a <type>ScriptEvent</type>
76                            and passed to the methods of this XScriptListener.
77        @param Helper
78                            Helper object for the implementation. This value will be
79                            passed to the XScriptListener as Helper property in the
80                            <type>ScriptEvent</type>.
81    */
82    void attachEvents(  [in] sequence< com::sun::star::uno::XInterface > Objects,
83                        [in] com::sun::star::script::XScriptListener xListener,
84                        [in] any Helper )
85            raises( com::sun::star::lang::IllegalArgumentException,
86                    com::sun::star::beans::IntrospectionException,
87                    com::sun::star::script::CannotCreateAdapterException,
88                    com::sun::star::lang::ServiceNotRegisteredException );
89
90};
91
92//=============================================================================
93
94}; }; }; };
95
96#endif
97
98