udkapi/com/sun/star/script/ScriptEventDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ScriptEventDescriptor.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_ScriptEventDescriptor_idl__
  31 #define __com_sun_star_script_ScriptEventDescriptor_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module script {
  37
  38 //=============================================================================
  39 /** describes an effect, especially a script to be executed,
  40     for a certain event given by the listener type and the name of the
  41     event method.
  42  */
  43 published struct ScriptEventDescriptor
  44 {
  45     /** listener type as string, same as listener-XIdlClass.getName().
  46      */
  47     string ListenerType;
  48
  49     //-------------------------------------------------------------------------
  50     /** event method as string.
  51      */
  52     string EventMethod;
  53
  54     //-------------------------------------------------------------------------
  55     /** data to be used if the addListener method needs an additional
  56         parameter.
  57         <p>If the type of this parameter is different from string,
  58         it will be converted, when added.</p>
  59      */
  60     string AddListenerParam;
  61
  62     //-------------------------------------------------------------------------
  63     /** type of the script language as string; for example, "Basic" or "StarScript".
  64      */
  65     string ScriptType;
  66
  67     //-------------------------------------------------------------------------
  68     /** script code as string (the code has to correspond with the language
  69         defined by ScriptType).
  70      */
  71     string ScriptCode;
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif