1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_plugin_XPluginContext_idl__ 24cdf0e10cSrcweir#define __com_sun_star_plugin_XPluginContext_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_plugin_XPlugin_idl__ 31cdf0e10cSrcweir#include <com/sun/star/plugin/XPlugin.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_plugin_PluginVariable_idl__ 35cdf0e10cSrcweir#include <com/sun/star/plugin/PluginVariable.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_plugin_PluginException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/plugin/PluginException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_lang_XEventListener_idl__ 43cdf0e10cSrcweir#include <com/sun/star/lang/XEventListener.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_io_XActiveDataSource_idl__ 47cdf0e10cSrcweir#include <com/sun/star/io/XActiveDataSource.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir module com { module sun { module star { module plugin { 54cdf0e10cSrcweir 55cdf0e10cSrcweir//============================================================================= 56cdf0e10cSrcweir 57cdf0e10cSrcweir/** Interface receiving calls from a plugin library. 58cdf0e10cSrcweir A default context can be created using the <type>PluginManager</type>. 59cdf0e10cSrcweir*/ 60cdf0e10cSrcweirpublished interface XPluginContext: com::sun::star::uno::XInterface 61cdf0e10cSrcweir{ 62cdf0e10cSrcweir /** Requests global application parameters like display connection 63cdf0e10cSrcweir on UNIX systems. 64cdf0e10cSrcweir 65cdf0e10cSrcweir @param xPlugin 66cdf0e10cSrcweir plugin 67cdf0e10cSrcweir @param aVariable 68cdf0e10cSrcweir variable 69cdf0e10cSrcweir @return value 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir string getValue( [in] com::sun::star::plugin::XPlugin xPlugin, 72cdf0e10cSrcweir [in] com::sun::star::plugin::PluginVariable aVariable ) 73cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 74cdf0e10cSrcweir 75cdf0e10cSrcweir /** Requests a notification of completion of the operation on an URL. 76cdf0e10cSrcweir 77cdf0e10cSrcweir @param plugin 78cdf0e10cSrcweir plugin 79cdf0e10cSrcweir @param url 80cdf0e10cSrcweir url 81cdf0e10cSrcweir @param target 82cdf0e10cSrcweir target frame 83cdf0e10cSrcweir @param listener 84cdf0e10cSrcweir event listener 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir void getURLNotify( [in] com::sun::star::plugin::XPlugin plugin, 87cdf0e10cSrcweir [in] string url, 88cdf0e10cSrcweir [in] string target, 89cdf0e10cSrcweir [in] com::sun::star::lang::XEventListener listener ) 90cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 91cdf0e10cSrcweir 92cdf0e10cSrcweir /** Requests an URL to be loaded into the frame target. 93cdf0e10cSrcweir 94cdf0e10cSrcweir @param plugin 95cdf0e10cSrcweir plugin 96cdf0e10cSrcweir @param url 97cdf0e10cSrcweir url 98cdf0e10cSrcweir @param target 99cdf0e10cSrcweir target frame 100cdf0e10cSrcweir */ 101cdf0e10cSrcweir void getURL( [in] com::sun::star::plugin::XPlugin plugin, 102cdf0e10cSrcweir [in] string url, 103cdf0e10cSrcweir [in] string target ) 104cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 105cdf0e10cSrcweir 106cdf0e10cSrcweir /** Posts data from a buffer or file to an URL and receives a 107cdf0e10cSrcweir notification upon completion. 108cdf0e10cSrcweir 109cdf0e10cSrcweir @param plugin 110cdf0e10cSrcweir plugin 111cdf0e10cSrcweir @param url 112cdf0e10cSrcweir url 113cdf0e10cSrcweir @param target 114cdf0e10cSrcweir target frame 115cdf0e10cSrcweir @param buf 116cdf0e10cSrcweir data 117cdf0e10cSrcweir @param file 118cdf0e10cSrcweir whether data is from file 119cdf0e10cSrcweir @param listener 120cdf0e10cSrcweir event listener 121cdf0e10cSrcweir */ 122cdf0e10cSrcweir void postURLNotify( [in] com::sun::star::plugin::XPlugin plugin, 123cdf0e10cSrcweir [in] string url, 124cdf0e10cSrcweir [in] string target, 125cdf0e10cSrcweir [in] sequence<byte> buf, 126cdf0e10cSrcweir [in] boolean file, 127cdf0e10cSrcweir [in] com::sun::star::lang::XEventListener listener ) 128cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 129cdf0e10cSrcweir 130cdf0e10cSrcweir /** Posts data from a buffer or file to an URL. 131cdf0e10cSrcweir 132cdf0e10cSrcweir @param plugin 133cdf0e10cSrcweir plugin 134cdf0e10cSrcweir @param url 135cdf0e10cSrcweir url 136cdf0e10cSrcweir @param target 137cdf0e10cSrcweir target frame 138cdf0e10cSrcweir @param buf 139cdf0e10cSrcweir data 140cdf0e10cSrcweir @param file 141cdf0e10cSrcweir whether data is from file 142cdf0e10cSrcweir */ 143cdf0e10cSrcweir void postURL( [in] com::sun::star::plugin::XPlugin plugin, 144cdf0e10cSrcweir [in] string url, 145cdf0e10cSrcweir [in] string target, 146cdf0e10cSrcweir [in] sequence<byte> buf, 147cdf0e10cSrcweir [in] boolean file ) 148cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 149cdf0e10cSrcweir 150cdf0e10cSrcweir /** Requests a new stream that is created by the plugin and consumed 151cdf0e10cSrcweir by the browser. 152cdf0e10cSrcweir 153cdf0e10cSrcweir @param plugin 154cdf0e10cSrcweir plugin 155cdf0e10cSrcweir @param mimetype 156cdf0e10cSrcweir mime type 157cdf0e10cSrcweir @param target 158cdf0e10cSrcweir target frame 159cdf0e10cSrcweir @param aSource 160cdf0e10cSrcweir data source 161cdf0e10cSrcweir */ 162cdf0e10cSrcweir void newStream( [in] com::sun::star::plugin::XPlugin plugin, 163cdf0e10cSrcweir [in] string mimetype, 164cdf0e10cSrcweir [in] string target, 165cdf0e10cSrcweir [in] com::sun::star::io::XActiveDataSource aSource ) 166cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 167cdf0e10cSrcweir 168cdf0e10cSrcweir /** Displays a message in the browser status line. 169cdf0e10cSrcweir 170cdf0e10cSrcweir @param plugin 171cdf0e10cSrcweir plugin 172cdf0e10cSrcweir @param message 173cdf0e10cSrcweir message 174cdf0e10cSrcweir */ 175cdf0e10cSrcweir void displayStatusText( [in] com::sun::star::plugin::XPlugin plugin, 176cdf0e10cSrcweir [in] string message ) 177cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 178cdf0e10cSrcweir 179cdf0e10cSrcweir /** Returns an application dependent identification string. 180cdf0e10cSrcweir This is the same string that is transmitted by a browser to an http server. 181cdf0e10cSrcweir 182cdf0e10cSrcweir @param plugin 183cdf0e10cSrcweir plugin 184cdf0e10cSrcweir @return id 185cdf0e10cSrcweir */ 186cdf0e10cSrcweir string getUserAgent( [in] com::sun::star::plugin::XPlugin plugin ) 187cdf0e10cSrcweir raises( com::sun::star::plugin::PluginException ); 188cdf0e10cSrcweir}; 189cdf0e10cSrcweir 190cdf0e10cSrcweir//============================================================================= 191cdf0e10cSrcweir 192cdf0e10cSrcweir}; }; }; }; 193cdf0e10cSrcweir 194cdf0e10cSrcweir#endif 195