Files
loongoffice/udkapi/com/sun/star/script/ScriptEventDescriptor.idl
2001-11-16 14:10:40 +00:00

149 lines
5.4 KiB
Plaintext

/*************************************************************************
*
* $RCSfile: ScriptEventDescriptor.idl,v $
*
* $Revision: 1.5 $
*
* last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_script_ScriptEventDescriptor_idl__
#define __com_sun_star_script_ScriptEventDescriptor_idl__
//=============================================================================
module com { module sun { module star { module script {
//=============================================================================
// DocMerge from xml: struct com::sun::star::script::ScriptEventDescriptor
/** 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.
*/
struct ScriptEventDescriptor
{
// DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::ListenerType
/** listener type as string, same as listener-XIdlClass.getName().
*/
string ListenerType;
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR ScriptEventDescriptor::EventMethod
// DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::EventMethod
/** event method as string.
*/
string EventMethod;
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR ScriptEventDescriptor::AddListenerParam
// DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::AddListenerParam
/** 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;
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR ScriptEventDescriptor::ScriptType
// DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::ScriptType
/** type of the script language as string; for example, "Basic" or "StarScript".
*/
string ScriptType;
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR ScriptEventDescriptor::ScriptCode
// DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::ScriptCode
/** script code as string (the code has to correspond with the language
defined by ScriptType).
*/
string ScriptCode;
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.4 2000/11/08 12:28:52 mi
moved from api
Revision 1.1.1.1 2000/09/18 23:35:35 hjs
initial import
Revision 1.5 2000/09/11 11:52:38 mi
documentation merged from XML
Revision 1.3 2000/04/20 14:14:36 mm
#74031# better documentation
Revision 1.2 2000/02/07 11:24:51 mi
zu #70728# missing documentation marked
Revision 1.1.1.1 1999/11/11 09:48:45 jsc
new
=============================================================================*/
#endif