From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/script/provider/XScript.idl | 78 +++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 offapi/com/sun/star/script/provider/XScript.idl (limited to 'offapi/com/sun/star/script/provider/XScript.idl') diff --git a/offapi/com/sun/star/script/provider/XScript.idl b/offapi/com/sun/star/script/provider/XScript.idl new file mode 100644 index 000000000..d7538bc43 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScript.idl @@ -0,0 +1,78 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + +#ifndef __com_sun_star_script_provider_XScript_idl__ +#define __com_sun_star_script_provider_XScript_idl__ + +#include +#include +#include +#include +#include + + +module com { module sun { module star { module script { module provider { + +/** + This interface represents an invocable script or UNO function. +*/ +interface XScript : ::com::sun::star::uno::XInterface { + + /** + invoke the script or function represented by the implementing + object + + @param aParams + all parameters; pure, out parameters are undefined in sequence, + i.e., the value has to be ignored by the callee + @param aOutParamIndex + out indices, indicating the position of the out or inout + parameters in the list of arguments to the script + @param aOutParam + out parameters

+ For example, if the script had the signature
+ long foo( [inout] string a, [in] string b, [out] string c ) +
the call would look like
+ bar.invoke( {"foo", "foo2", "this-is-ignored" }, aOutParamIndex, aOutParam); +
and after the call the out sequences would contain
+ @code{.py} + aOutParamIndex={0,2}; + aOutParam={"string from a", "string from c"}; + @endcode + + @returns + the value returned from the function being invoked + + @throws ::com::sun::star::reflection::InvocationTargetException + if an error occurs while attempting to invoke a script the information is captured. If the error or exception is generated by the script itself it is wrapped as either ScriptErrorRaisedException or ScriptExceptionRaisedException or ScriptFrameworkErrorException are wrapped as ScriptFrameworkErrorExceptions. + */ + any invoke( + [in] sequence aParams, + [out] sequence aOutParamIndex, + [out] sequence aOutParam ) raises( + ::com::sun::star::script::provider::ScriptFrameworkErrorException , + ::com::sun::star::reflection::InvocationTargetException); + +}; + +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3