xref: /trunk/main/udkapi/com/sun/star/script/ScriptEventDescriptor.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*408a4873SAndrew Rist * distributed with this work for additional information
6*408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9*408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*408a4873SAndrew Rist * software distributed under the License is distributed on an
15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17*408a4873SAndrew Rist * specific language governing permissions and limitations
18*408a4873SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*408a4873SAndrew Rist *************************************************************/
21*408a4873SAndrew Rist
22*408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_script_ScriptEventDescriptor_idl__
24cdf0e10cSrcweir#define __com_sun_star_script_ScriptEventDescriptor_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir
27cdf0e10cSrcweir//=============================================================================
28cdf0e10cSrcweir
29cdf0e10cSrcweir module com {  module sun {  module star {  module script {
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir/** describes an effect, especially a script to be executed,
33cdf0e10cSrcweir    for a certain event given by the listener type and the name of the
34cdf0e10cSrcweir    event method.
35cdf0e10cSrcweir */
36cdf0e10cSrcweirpublished struct ScriptEventDescriptor
37cdf0e10cSrcweir{
38cdf0e10cSrcweir    /** listener type as string, same as listener-XIdlClass.getName().
39cdf0e10cSrcweir     */
40cdf0e10cSrcweir    string ListenerType;
41cdf0e10cSrcweir
42cdf0e10cSrcweir    //-------------------------------------------------------------------------
43cdf0e10cSrcweir    /** event method as string.
44cdf0e10cSrcweir     */
45cdf0e10cSrcweir    string EventMethod;
46cdf0e10cSrcweir
47cdf0e10cSrcweir    //-------------------------------------------------------------------------
48cdf0e10cSrcweir    /** data to be used if the addListener method needs an additional
49cdf0e10cSrcweir        parameter.
50cdf0e10cSrcweir        <p>If the type of this parameter is different from string,
51cdf0e10cSrcweir        it will be converted, when added.</p>
52cdf0e10cSrcweir     */
53cdf0e10cSrcweir    string AddListenerParam;
54cdf0e10cSrcweir
55cdf0e10cSrcweir    //-------------------------------------------------------------------------
56cdf0e10cSrcweir    /** type of the script language as string; for example, "Basic" or "StarScript".
57cdf0e10cSrcweir     */
58cdf0e10cSrcweir    string ScriptType;
59cdf0e10cSrcweir
60cdf0e10cSrcweir    //-------------------------------------------------------------------------
61cdf0e10cSrcweir    /** script code as string (the code has to correspond with the language
62cdf0e10cSrcweir        defined by ScriptType).
63cdf0e10cSrcweir     */
64cdf0e10cSrcweir    string ScriptCode;
65cdf0e10cSrcweir
66cdf0e10cSrcweir};
67cdf0e10cSrcweir
68cdf0e10cSrcweir//=============================================================================
69cdf0e10cSrcweir
70cdf0e10cSrcweir}; }; }; };
71cdf0e10cSrcweir
72cdf0e10cSrcweir#endif
73