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