summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script/ScriptEventDescriptor.idl
blob: 4cc7f85bda8e53898cd12ac6357496bb4d40f270 (plain)
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
/*************************************************************************
 *
 * 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_ScriptEventDescriptor_idl__
#define __com_sun_star_script_ScriptEventDescriptor_idl__


//=============================================================================

 module com {  module sun {  module star {  module script {

//=============================================================================
/** describes an effect, especially a script to be executed,
    for a certain event given by the listener type and the name of the
    event method.
 */
published struct ScriptEventDescriptor
{
    /** listener type as string, same as listener-XIdlClass.getName().
     */
    string ListenerType;

    //-------------------------------------------------------------------------
    /** event method as string.
     */
    string EventMethod;

    //-------------------------------------------------------------------------
    /** data to be used if the addListener method needs an additional
        parameter.
        <p>If the type of this parameter is different from string,
        it will be converted, when added.</p>
     */
    string AddListenerParam;

    //-------------------------------------------------------------------------
    /** type of the script language as string; for example, "Basic" or "StarScript".
     */
    string ScriptType;

    //-------------------------------------------------------------------------
    /** script code as string (the code has to correspond with the language
        defined by ScriptType).
     */
    string ScriptCode;

};

//=============================================================================

}; }; }; };

#endif