166 lines
6.1 KiB
Text
166 lines
6.1 KiB
Text
/*************************************************************************
|
|
*
|
|
* $RCSfile: XEngine.idl,v $
|
|
*
|
|
* $Revision: 1.8 $
|
|
*
|
|
* last change: $Author: obo $ $Date: 2004-06-03 16:24:22 $
|
|
*
|
|
* 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_XEngine_idl__
|
|
#define __com_sun_star_script_XEngine_idl__
|
|
|
|
#ifndef __com_sun_star_uno_XInterface_idl__
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_script_XLibraryAccess_idl__
|
|
#include <com/sun/star/script/XLibraryAccess.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_script_XEngineListener_idl__
|
|
#include <com/sun/star/script/XEngineListener.idl>
|
|
#endif
|
|
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module script {
|
|
|
|
//=============================================================================
|
|
/** makes it possible to control a scripting engine.
|
|
@deprecated
|
|
*/
|
|
published interface XEngine: com::sun::star::uno::XInterface
|
|
{
|
|
//-------------------------------------------------------------------------
|
|
/** sets an interface to an object as a scripting root.
|
|
|
|
<p>If the root object implements the XInvocation interface,
|
|
then the engine uses this interface to set/get properties and
|
|
call methods.
|
|
</p>
|
|
*/
|
|
void setRoot( [in] com::sun::star::uno::XInterface xRoot );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** gets an interface to the object which is the scripting root.
|
|
*/
|
|
com::sun::star::uno::XInterface getRoot();
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** sets an access object to get external functions.
|
|
*/
|
|
void setLibraryAccess( [in] com::sun::star::script::XLibraryAccess Library );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** compiles a script module in the scope of the root object.
|
|
*/
|
|
boolean compile( [in] string ModuleName,
|
|
[in] string Script,
|
|
[in] boolean CreateDebugInfo );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** runs a script specified by a string.
|
|
|
|
<p>The arguments given in <var>aArgs</var> can be ignored by
|
|
the engine. The Script is executed synchronously.</p>
|
|
*/
|
|
any run( [in] string aScript,
|
|
[in] com::sun::star::uno::XInterface xThis,
|
|
[in] sequence<any> aArgs );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** runs the script specified by a string and makes callbacks.
|
|
|
|
<p>The arguments given in <var>aArgs</var> can be ignored by
|
|
the engine. The script is executed asynchronously.
|
|
|
|
</p>
|
|
*/
|
|
void runAsync( [in] string acript,
|
|
[in] com::sun::star::uno::XInterface xThis,
|
|
[in] sequence<any> args,
|
|
[in] com::sun::star::script::XEngineListener xCallback );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** terminates the execution of the running script.
|
|
|
|
<p>The waiting queue is cleared too.</p>
|
|
*/
|
|
void cancel();
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** adds an engine listener.
|
|
|
|
<p>It is suggested to allow multiple registration of the same listener,
|
|
thus for each time a listener is added, it has to be removed.
|
|
*/
|
|
void addEngineListener( [in] com::sun::star::script::XEngineListener Listener );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** removes an engine listener.
|
|
|
|
<p>It is suggested to allow multiple registration of the same listener,
|
|
thus for each time a listener is added, it has to be removed.
|
|
*/
|
|
void removeEngineListener( [in] com::sun::star::script::XEngineListener Listener );
|
|
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|