offapi/com/sun/star/plugin/XPluginContext.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: XPluginContext.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_plugin_XPluginContext_idl__
  31 #define __com_sun_star_plugin_XPluginContext_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_plugin_XPlugin_idl__
  38 #include <com/sun/star/plugin/XPlugin.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_plugin_PluginVariable_idl__
  42 #include <com/sun/star/plugin/PluginVariable.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_plugin_PluginException_idl__
  46 #include <com/sun/star/plugin/PluginException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_XEventListener_idl__
  50 #include <com/sun/star/lang/XEventListener.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_io_XActiveDataSource_idl__
  54 #include <com/sun/star/io/XActiveDataSource.idl>
  55 #endif
  56
  57
  58 //=============================================================================
  59
  60  module com {  module sun {  module star {  module plugin {
  61
  62 //=============================================================================
  63
  64 /** Interface receiving calls from a plugin library.
  65     A default context can be created using the <type>PluginManager</type>.
  66 */
  67 published interface XPluginContext: com::sun::star::uno::XInterface
  68 {
  69     /** Requests global application parameters like display connection
  70         on UNIX systems.
  71
  72         @param xPlugin
  73                plugin
  74         @param aVariable
  75                variable
  76         @return value
  77     */
  78     string getValue( [in] com::sun::star::plugin::XPlugin xPlugin,
  79              [in] com::sun::star::plugin::PluginVariable aVariable )
  80             raises( com::sun::star::plugin::PluginException );
  81
  82     /** Requests a notification of completion of the operation on an URL.
  83
  84         @param plugin
  85                plugin
  86         @param url
  87                url
  88         @param target
  89                target frame
  90         @param listener
  91                event listener
  92     */
  93     void getURLNotify( [in] com::sun::star::plugin::XPlugin plugin,
  94              [in] string url,
  95              [in] string target,
  96              [in] com::sun::star::lang::XEventListener listener )
  97             raises( com::sun::star::plugin::PluginException );
  98
  99     /** Requests an URL to be loaded into the frame target.
 100
 101         @param plugin
 102                plugin
 103         @param url
 104                url
 105         @param target
 106                target frame
 107     */
 108     void getURL( [in] com::sun::star::plugin::XPlugin plugin,
 109              [in] string url,
 110              [in] string target )
 111             raises( com::sun::star::plugin::PluginException );
 112
 113     /** Posts data from a buffer or file to an URL and receives a
 114         notification upon completion.
 115
 116         @param plugin
 117                plugin
 118         @param url
 119                url
 120         @param target
 121                target frame
 122         @param buf
 123                data
 124         @param file
 125                whether data is from file
 126         @param listener
 127                event listener
 128     */
 129     void postURLNotify( [in] com::sun::star::plugin::XPlugin plugin,
 130              [in] string url,
 131              [in] string target,
 132              [in] sequence<byte> buf,
 133              [in] boolean file,
 134              [in] com::sun::star::lang::XEventListener listener )
 135             raises( com::sun::star::plugin::PluginException );
 136
 137     /** Posts data from a buffer or file to an URL.
 138
 139         @param plugin
 140                plugin
 141         @param url
 142                url
 143         @param target
 144                target frame
 145         @param buf
 146                data
 147         @param file
 148                whether data is from file
 149     */
 150     void postURL( [in] com::sun::star::plugin::XPlugin plugin,
 151              [in] string url,
 152              [in] string target,
 153              [in] sequence<byte> buf,
 154              [in] boolean file )
 155             raises( com::sun::star::plugin::PluginException );
 156
 157     /** Requests a new stream that is created by the plugin and consumed
 158         by the browser.
 159
 160         @param plugin
 161                plugin
 162         @param mimetype
 163                mime type
 164         @param target
 165                target frame
 166         @param aSource
 167                data source
 168     */
 169     void newStream( [in] com::sun::star::plugin::XPlugin plugin,
 170              [in] string mimetype,
 171              [in] string target,
 172              [in] com::sun::star::io::XActiveDataSource aSource )
 173             raises( com::sun::star::plugin::PluginException );
 174
 175     /** Displays a message in the browser status line.
 176
 177         @param plugin
 178                plugin
 179         @param message
 180                message
 181     */
 182     void displayStatusText( [in] com::sun::star::plugin::XPlugin plugin,
 183              [in] string message )
 184             raises( com::sun::star::plugin::PluginException );
 185
 186     /** Returns an application dependent identification string.
 187         This is the same string that is transmitted by a browser to an http server.
 188
 189         @param plugin
 190                plugin
 191         @return id
 192     */
 193     string getUserAgent( [in] com::sun::star::plugin::XPlugin plugin )
 194             raises( com::sun::star::plugin::PluginException );
 195 };
 196
 197 //=============================================================================
 198
 199 }; }; }; };
 200
 201 #endif