/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: ScriptEventDescriptor.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 16:15:35 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
