1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*************************************************************************
*
* 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
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_script_XEventAttacherManager_idl__
#define __com_sun_star_script_XEventAttacherManager_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_script_ScriptEventDescriptor_idl__
#include <com/sun/star/script/ScriptEventDescriptor.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_ServiceNotRegisteredException_idl__
#include <com/sun/star/lang/ServiceNotRegisteredException.idl>
#endif
#ifndef __com_sun_star_script_XScriptListener_idl__
#include <com/sun/star/script/XScriptListener.idl>
#endif
//=============================================================================
module com { module sun { module star { module script {
//=============================================================================
/** registers listeners for specified events.
*/
published interface XEventAttacherManager: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** registers one event for an object identified by its index.
<p>If any object is attached under this index, then this
event is attached automatically.</p>
<p>Exceptions of type
<type scope="com::sun::star::beans">IntrospectionException</type> and
<type scope="com::sun::star::script">CannotCreateAdapterException</type>
that can be thrown by methods of <type>XEventAttacher</type> are caught
and ignored.</p>
*/
void registerScriptEvent( [in] long nIndex,
[in] com::sun::star::script::ScriptEventDescriptor aScriptEvent )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** registers several events for an object identified by its index.
<p>The result is the same as if the method <member>registerScriptEvent
</member> was called once for each <type>ScriptEventDescriptor</type>
in the sequence.</p>
<p>If any object is attached under this index, then this
event is attached automatically (see <member>attach</member>)</p>
<p>Exceptions of type
<type scope="com::sun::star::beans">IntrospectionException</type> and
<type scope="com::sun::star::script">CannotCreateAdapterException</type>
that can be thrown by methods of <type>XEventAttacher</type> are caught
and ignored.</p>
@see registerScriptEvent
@see attach
*/
void registerScriptEvents( [in] long nIndex,
[in] sequence<com::sun::star::script::ScriptEventDescriptor> aScriptEvents )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** revokes the registration of an event.
<p>The parameters <var>ListenerType</var> and
<var>EventMethod</var> are equivalent to the first two
members of the <type>ScriptEventDescriptor</type>
used to register events. If this event at this index has
been attached to any object, it is detached automatically
(see <member>attach</member>).</p>
<p>Exceptions of type
<type scope="com::sun::star::beans">IntrospectionException</type> and
<type scope="com::sun::star::script">CannotCreateAdapterException</type>
that can be thrown by methods of <type>XEventAttacher</type> are caught
and ignored.</p>
@see attach
*/
void revokeScriptEvent( [in] long nIndex,
[in] string aListenerType,
[in] string aEventMethod,
[in] string aRemoveListenerParam )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** revokes all events which are registered for the given index.
<p>If the events at this index have been attached to any
object, they are detached automatically.
(see <member>attach</member>).</p>
@see attach
*/
void revokeScriptEvents( [in] long nIndex )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** creates an empty entry at the given position.
<p>The index <var>n</var> of all entries with <code>n &gt;=
nIndex</code> will be increased by one.</p>
*/
void insertEntry( [in] long nIndex )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** removes the entry at the given position.
<p>If any events are registered at this index, they will
be revoked, too. So if the events at this index have been
attached to any object they are detached automatically.
(see <member>attach</member>).</p>
@see attach
*/
void removeEntry( [in] long nIndex )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** @eturns
all events registered for the given object index.
@param Index
an index previously inserted with the method insertEntry.
@throws IllegalArgumentException
if Index is not valid.
*/
sequence<com::sun::star::script::ScriptEventDescriptor> getScriptEvents( [in] long Index )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** attaches all the <type>ScriptEvent</type>s which are registered
for the given index to the given object.
<p>Exceptions of type
<type scope="com::sun::star::beans">IntrospectionException</type> and
<type scope="com::sun::star::script">CannotCreateAdapterException</type>
that can be thrown by methods of <type>XEventAttacher</type> are caught
and ignored.</p>
*/
void attach( [in] long nIndex,
[in] com::sun::star::uno::XInterface xObject,
[in] any aHelper )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::ServiceNotRegisteredException );
//-------------------------------------------------------------------------
/** detaches all the <type>ScriptEvent</type>s from the given object
which are registered at this object for the given index.
<p>Exceptions of type
<type scope="com::sun::star::beans">IntrospectionException</type> and
<type scope="com::sun::star::script">CannotCreateAdapterException</type>
that can be thrown by methods of <type>XEventAttacher</type> are caught
and ignored.</p>
*/
void detach( [in] long nIndex,
[in] com::sun::star::uno::XInterface xObject )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** adds an <type>XScriptListener</type> that will be notified when an
event takes place. For that a
<type>ScriptEventDescriptor</type> is registered at and
attached to an object by an <type>XEventAttacherManager</type>.
<p>It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
@see removeScriptListener
*/
void addScriptListener( [in] com::sun::star::script::XScriptListener xListener )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** removes a <type>XScriptListener</type> from the listener list.
<p>Nothing happens if the listener is not registered.
<p>It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
@see addScriptListener
*/
void removeScriptListener( [in] com::sun::star::script::XScriptListener Listener )
raises( com::sun::star::lang::IllegalArgumentException );
};
//=============================================================================
}; }; }; };
#endif
|
