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_ScriptEventDescriptor_idl__
24#define __com_sun_star_script_ScriptEventDescriptor_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module script {
30
31//=============================================================================
32/** describes an effect, especially a script to be executed,
33	for a certain event given by the listener type and the name of the
34	event method.
35 */
36published struct ScriptEventDescriptor
37{
38	/** listener type as string, same as listener-XIdlClass.getName().
39	 */
40	string ListenerType;
41
42	//-------------------------------------------------------------------------
43	/** event method as string.
44	 */
45	string EventMethod;
46
47	//-------------------------------------------------------------------------
48	/** data to be used if the addListener method needs an additional
49		parameter.
50		<p>If the type of this parameter is different from string,
51		it will be converted, when added.</p>
52	 */
53	string AddListenerParam;
54
55	//-------------------------------------------------------------------------
56	/** type of the script language as string; for example, "Basic" or "StarScript".
57	 */
58	string ScriptType;
59
60	//-------------------------------------------------------------------------
61	/** script code as string (the code has to correspond with the language
62		defined by ScriptType).
63	 */
64	string ScriptCode;
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72#endif
73