1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_script_provider_XScriptContext_idl__ 29#define __com_sun_star_script_provider_XScriptContext_idl__ 30 31#ifndef __com_sun_star_uno_XInterface_idl__ 32#include <com/sun/star/uno/XInterface.idl> 33#endif 34 35#ifndef __com_sun_star_frame_XDesktop_idl__ 36#include <com/sun/star/frame/XDesktop.idl> 37#endif 38 39#ifndef __com_sun_star_frame_XModel_idl__ 40#include <com/sun/star/frame/XModel.idl> 41#endif 42 43#ifndef __com_sun_star_uno_XComponentContext_idl__ 44#include <com/sun/star/uno/XComponentContext.idl> 45#endif 46 47 48module com { module sun { module star { module document { 49 interface XScriptInvocationContext; 50}; }; }; }; 51 52//=========================================================================== 53 54module com { module sun { module star { module script { module provider { 55 56//=========================================================================== 57/** 58 This interface is provided to scripts, and provides a means of access to 59 the various interfaces which they might need to perform some action on 60 a document. It is required to be passed as the first argument for any 61 Java scripts. 62*/ 63interface XScriptContext : ::com::sun::star::uno::XInterface { 64 65 //---------------------------------------------------------------------- 66 /** 67 Obtain the document reference on which the script can operate 68 69 @returns 70 <type scope="com::sun::star::frame">XModel</type> interface 71 */ 72 ::com::sun::star::frame::XModel getDocument(); 73 74 /** provides access to the context where the script was invoked 75 76 <p>In some cases, it is possible that scripts, embedded in a document, 77 are executed from within a context which is <em>not</em> the document 78 itself. In this case, the <code>getInvocationContext</code> member allows 79 to access this context.</p> 80 81 <p>Note that the returned context is allowed to be <NULL/>, in this case, 82 the document as returned by <code>getDocument</code> is the invocation context.</p> 83 84 <p>If the returned context is not <NULL/>, its <code>ScriptContainer</code> attribute 85 equals the document as returned by <code>XScriptContext::getDocument</code>.</p> 86 87 @since OOo 3.0 88 */ 89 ::com::sun::star::document::XScriptInvocationContext getInvocationContext(); 90 91 /** 92 Obtain the desktop reference on which the script can operate 93 94 @returns 95 <type scope="com::sun::star::frame">XDesktop</type> interface 96 */ 97 ::com::sun::star::frame::XDesktop getDesktop(); 98 99 /** 100 Obtain the component context which the script can use to create 101 other uno components 102 103 @returns 104 <type scope="com::sun::star::uno">XComponentContext</type> interface 105 */ 106 ::com::sun::star::uno::XComponentContext getComponentContext(); 107 108 109}; 110 111//=========================================================================== 112}; }; }; }; }; // ::com::sun::star::script::provider 113 114#endif 115