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
28#ifndef __com_sun_star_script_vba_VBAScriptEventId_idl__
29#define __com_sun_star_script_vba_VBAScriptEventId_idl__
30
31//=============================================================================
32
33module com {  module sun {  module star { module script { module vba {
34
35//=============================================================================
36
37/** Identifies a VBA script event fired via <member>XVBACompatibility::
38    broadcastVBAScriptEvent</member>, and received by <member>
39    XVBAScriptListener::notifyVBAScriptEvent</member>.
40
41    @see VBAScriptEvent
42    @see XVBACompatibility
43    @see XVBAScriptListener
44 */
45constants VBAScriptEventId
46{
47    //-------------------------------------------------------------------------
48    /** This event is fired when a VBA script in the current document has been
49        started.
50
51        <p>Several scripts may run simultaneously, e.g. when a running script
52        triggers a document event that starts another script.</p>
53
54        <p>The number of running scripts can be obtained via <member>
55        XVBACompatibility::RunningVBAScripts</member>. The number returned
56        there will already contain the new script notified with this event.</p>
57
58        <p>The member <member>VBAScriptEvent::ModuleName</member> of the event
59        object will contain the name of the code module that contains the
60        started script.</p>
61     */
62    const long SCRIPT_STARTED = 0;
63
64    //-------------------------------------------------------------------------
65    /** This event is fired when a VBA script in the current document stops
66        running.
67
68        <p>Several scripts may run simultaneously, e.g. when a running script
69        triggers a document event that starts another script.</p>
70
71        <p>The number of scripts still running can be obtained via <member>
72        XVBACompatibility::RunningVBAScripts</member>. The number returned
73        there will not contain the stopped script notified with this event
74        anymore.</p>
75
76        <p>The member <member>VBAScriptEvent::ModuleName</member> of the event
77        object will contain the name of the code module that contains the
78        script that has been stopped.</p>
79     */
80    const long SCRIPT_STOPPED = 1;
81
82    //-------------------------------------------------------------------------
83    /** This event is fired when a VBA script in the current document tries to
84        instanciate a userform.
85
86        <p>The member <member>VBAScriptEvent::ModuleName</member> of the event
87        object will contain the name of the userform module.</p>
88     */
89    const long INITIALIZE_USERFORM = 2;
90
91    //-------------------------------------------------------------------------
92};
93
94//=============================================================================
95
96}; }; }; }; };
97
98//=============================================================================
99
100#endif
101