merged tag ooo/OOO330_m14
[LibreOffice.git] / udkapi / com / sun / star / script / ScriptEvent.idl
blob040124dbafd0647002031b52e33dbb10e6f92877
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
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.
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).
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.
26 ************************************************************************/
27 #ifndef __com_sun_star_script_ScriptEvent_idl__
28 #define __com_sun_star_script_ScriptEvent_idl__
30 #ifndef __com_sun_star_script_AllEventObject_idl__
31 #include <com/sun/star/script/AllEventObject.idl>
32 #endif
35 //=============================================================================
37 module com { module sun { module star { module script {
39 //=============================================================================
40 /** script event that gets delivered whenever a script event takes place.
41 <p>For that to happen, a "ScriptEventDescriptor" must be registered at
42 and attached to an object by an <type>XEventAttacherManager</type>.</p>
44 published struct ScriptEvent: com::sun::star::script::AllEventObject
46 //-------------------------------------------------------------------------
47 /** type of the script language as string; for example, "Basic" or "StarScript".
49 string ScriptType;
51 //-------------------------------------------------------------------------
52 /** script code as string.
54 <p>The code has to correspond with the language
55 defined by ScriptType.</p>
57 string ScriptCode;
61 //=============================================================================
63 }; }; }; };
65 #endif