offapi/com/sun/star/script/provider/XScriptContext.idl

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