diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
commit | 267c6f2ac71f92999e969232431ba04678e7437e (patch) | |
tree | 358c9467650e1d0a1d7227a21dac2e3d08b622b2 /offapi/com/sun/star/script/provider/XScriptContext.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.tar.xz libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.zip |
Adding upstream version 4:24.2.0.upstream/4%24.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/script/provider/XScriptContext.idl')
-rw-r--r-- | offapi/com/sun/star/script/provider/XScriptContext.idl | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/provider/XScriptContext.idl b/offapi/com/sun/star/script/provider/XScriptContext.idl new file mode 100644 index 0000000000..231f67bb3e --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptContext.idl @@ -0,0 +1,83 @@ +/* -*- 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 . + */ + + +module com { module sun { module star { module document { + interface XScriptInvocationContext; +}; }; }; }; + + +module com { module sun { module star { module script { module provider { + +/** + This interface is provided to scripts, and provides a means of access to + the various interfaces which they might need to perform some action on + a document. It is required to be passed as the first argument for any + Java scripts. +*/ +interface XScriptContext : ::com::sun::star::uno::XInterface { + + /** + Obtain the document reference on which the script can operate + + @returns + com::sun::star::frame::XModel interface + */ + ::com::sun::star::frame::XModel getDocument(); + + /** provides access to the context where the script was invoked + + <p>In some cases, it is possible that scripts, embedded in a document, + are executed from within a context which is <em>not</em> the document + itself. In this case, the <code>getInvocationContext</code> member allows + to access this context.</p> + + <p>Note that the returned context is allowed to be `NULL`, in this case, + the document as returned by <code>getDocument</code> is the invocation context.</p> + + <p>If the returned context is not `NULL`, its <code>ScriptContainer</code> attribute + equals the document as returned by <code>XScriptContext::getDocument</code>.</p> + + @since OOo 3.0 + */ + ::com::sun::star::document::XScriptInvocationContext getInvocationContext(); + + /** + Obtain the desktop reference on which the script can operate + + @returns + com::sun::star::frame::XDesktop interface + */ + ::com::sun::star::frame::XDesktop getDesktop(); + + /** + Obtain the component context which the script can use to create + other uno components + + @returns + com::sun::star::uno::XComponentContext interface + */ + ::com::sun::star::uno::XComponentContext getComponentContext(); + + +}; + +}; }; }; }; }; // ::com::sun::star::script::provider + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |