xref: /aoo42x/main/udkapi/com/sun/star/script/XEngine.idl (revision 408a4873)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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