xref: /AOO41X/main/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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#ifndef __com_sun_star_mozilla_XPluginInstancePeer_idl__
28#define __com_sun_star_mozilla_XPluginInstancePeer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_io_XActiveDataSource_idl__
35#include <com/sun/star/io/XActiveDataSource.idl>
36#endif
37
38#ifndef __com_sun_star_io_XInputStream_idl__
39#include <com/sun/star/io/XInputStream.idl>
40#endif
41
42#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
43#include <com/sun/star/lang/XMultiServiceFactory.idl>
44#endif
45
46//=============================================================================
47
48 module com {  module sun {  module star {  module mozilla {
49
50//=============================================================================
51
52 published interface XPluginInstanceNotifySink;
53
54//=============================================================================
55
56
57// DocMerge from xml: interface com::sun::star::mozilla::XPluginInstancePeer
58/** Allows to communicate with a plugin from the office side.
59	This interface is oriented for communication with browsers plugins.
60 */
61published interface XPluginInstancePeer: com::sun::star::uno::XInterface
62{
63	//-------------------------------------------------------------------------
64
65
66	// DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::setWindowSize
67	/** Alters the plugin's window size in the browser window.
68
69		@param width	[in]: the new window width
70		@param height	[in]: the new window height
71
72		@return <CODE>TRUE</CODE> on success
73	 */
74	boolean setWindowSize( [in] long width, [in] long heigth );
75
76	//-------------------------------------------------------------------------
77
78
79	// DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::showStatusMessage
80	/** Show status / hint message in browser's message area.
81
82		@param message	[in]: the string to be displayed
83	 */
84	[oneway] void showStatusMessage( [in] string message );
85
86	//-------------------------------------------------------------------------
87
88
89	// DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::enableScripting
90	/** Indicates to the plugin that the document was loaded successfully and scripting
91		interfaces are now available.
92
93		@param document			[in]: the active document
94		@param servicemanager	[in]: the office servicemanager
95
96	 */
97	[oneway] void enableScripting( [in] com::sun::star::uno::XInterface document, [in] com::sun::star::lang::XMultiServiceFactory servicemanager );
98
99	//-------------------------------------------------------------------------
100
101
102	// DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::newStream
103	/** Creates a new stream of data produced by the plug-in and consumed by
104		the browser.
105
106		@param MIMEDesc	[in]:	the MIME type of the plug-in to create
107		@param target	[in]:	the name of the target window or frame (supports _blank, _self)
108		@param data		[in]:	on success the outputstream will be	associated with this instance
109
110	 */
111	[oneway] void newStream(
112		[in] string MIMEDesc,
113		[in] string target,
114		[in] com::sun::star::io::XActiveDataSource data
115	);
116
117	//-------------------------------------------------------------------------
118
119
120	// DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::getURL
121	/** Fetches an URL into the target window. The parameters and their meaning map to the
122		corresponding Netscape-API call.
123
124		@param aURL				[in]: the URL to be fetched
125		@param target			[in]: the name of the target window or frame (supports _blank, _self)
126		@param alternativeHost	[in]: alternativeHost
127		@param referrer			[in]: referrer
128		@param sink				[in]: the sink is notified on success
129
130	 */
131	[oneway] void getURL (
132		[in] string aURL,
133		[in] string target,
134		[in] string alternativeHost,
135		[in] string referrer,
136		[in] XPluginInstanceNotifySink sink
137	);
138
139	//-------------------------------------------------------------------------
140
141
142	// DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::postURL
143	/** Posts to a URL with post data and/or post headers. The parameters and their meaning
144		map to the corresponding Netscape-API call.
145
146		@param aURL				[in]: the URL to be posted to
147		@param postData			[in]: the data to be posted
148		@param target			[in]: the name of the target window or frame (supports _blank, _self)
149		@param alternativeHost	[in]: alternativeHost
150		@param referrer			[in]: referrer
151		@param postHeaders		[in]: the header to be posted
152		@param sink				[in]: the sink is notified on success
153
154	 */
155	[oneway] void postURL (
156		[in] string aURL,
157		[in] com::sun::star::io::XInputStream postData,
158		[in] string target,
159		[in] string alternativeHost,
160		[in] string referrer,
161		[in] com::sun::star::io::XInputStream postHeaders,
162		[in] XPluginInstanceNotifySink sink
163	);
164};
165
166//=============================================================================
167
168}; }; }; };
169
170#endif
171