1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_mozilla_XPluginInstance_idl__ 24#define __com_sun_star_mozilla_XPluginInstance_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_io_XInputStream_idl__ 31#include <com/sun/star/io/XInputStream.idl> 32#endif 33 34//============================================================================= 35 36 module com { module sun { module star { module mozilla { 37 38//============================================================================= 39 40 41// DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start 42/** Allows to control an office side plugin instance and to communicate with it. 43 This interface is oriented for communication with browsers plugins. 44 */ 45published interface XPluginInstance: com::sun::star::uno::XInterface 46{ 47 //------------------------------------------------------------------------- 48 49 50 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start 51 /** Starts plugin operation. This is called after a plugin instance is 52 created. 53 */ 54 [oneway] void start(); 55 56 //------------------------------------------------------------------------- 57 58 59 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::stop 60 /** Stops plugin operation. This is called when the user goes to another web 61 page. The <member>XPluginInstance::destroy</member> method is directly called 62 afterwards. 63 */ 64 [oneway] void stop(); 65 66 //------------------------------------------------------------------------- 67 68 69 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::destroy 70 /** Destroy the plugin instance. This method is called when it is no 71 longer possible to return to the plugin instance, because it was 72 destroyed by the browser (e.g., window close). 73 */ 74 [oneway] void destroy(); 75 76 //------------------------------------------------------------------------- 77 78 79 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::createWindow 80 /** Creates a new window for plugin operation. 81 82 @param PlatformParentData [in]: platform dependent window data 83 @param embedded [in]: selects embedded or full page plugin mode 84 85 */ 86 [oneway] void createWindow( [in] any PlatformParentData, [in] boolean embedded ); 87 88 //------------------------------------------------------------------------- 89 90 91 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::newStream 92 /** Notifies the plugin of a new stream to display. 93 94 @param MIMEDesc [in]: the MIMEtype of the data stream 95 @param theURL [in]: the URL that denotes the stream 96 @param filter [in]: a filter string to suggest a component that should handle the document 97 @param stream [in]: the data stream 98 @param sessiondata [in]: the data specifying the current session 99 100 */ 101 [oneway] void newStream( 102 [in] string MIMEDesc, 103 [in] string theURL, 104 [in] string filter, 105 [in] ::com::sun::star::io::XInputStream stream , 106 [in] any sessionData 107 ); 108 109 //------------------------------------------------------------------------- 110 111 112 // DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::newURL 113 /** Notifies the plugin of a new url to open as document. 114 115 @param MIMEDesc [in]: the MIMEtype of the data stream 116 @param theURL [in]: the URL to be openend 117 @param filter [in]: a filter string to suggest a component that should handle the document 118 @param sessiondata [in]: the data specifying the current session 119 120 */ 121 [oneway] void newURL( [in] string MIMEDesc, [in] string theURL, [in] string filter, [in] any sessionData ); 122 123 //------------------------------------------------------------------------- 124 125 126 // DocMerge from idl: method com::sun::star::mozilla::XPluginInstance::getHttpServerURL 127 /** Retrieves the URL of the HTTP Loadbalancing Slave. 128 129 @param aURL [out]: the full qualified host name of the LBS 130 @param aPort [out]: the port number 131 @param aPrefix [out]: the url prefix to the portal 132 133 */ 134 void getHttpServerURL( [out] string aHost, [out] unsigned short aPort, 135 [out] string aPrefix); 136}; 137 138//============================================================================= 139 140}; }; }; }; 141 142#endif 143