summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl
blob: b2d6cdc8a59ed7a8081157d11df8ab0ec0092656 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/*************************************************************************
 *
 *  $RCSfile: XPluginInstancePeer.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:06:12 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_mozilla_XPluginInstancePeer_idl__ 
#define __com_sun_star_mozilla_XPluginInstancePeer_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_io_XActiveDataSource_idl__ 
#include <com/sun/star/io/XActiveDataSource.idl> 
#endif 
 
#ifndef __com_sun_star_io_XInputStream_idl__ 
#include <com/sun/star/io/XInputStream.idl> 
#endif 
 
#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ 
#include <com/sun/star/lang/XMultiServiceFactory.idl> 
#endif 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module mozilla { 
 
//============================================================================= 
 
interface XPluginInstanceNotifySink; 
 
//============================================================================= 
 
 
// DocMerge from xml: interface com::sun::star::mozilla::XPluginInstancePeer
/** Allows to communicate with a plugin from the office side.
    This interface is oriented for communication with browsers plugins.
 */
interface XPluginInstancePeer: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
 
    // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::setWindowSize
    /** Alters the plugin's window size in the browser window.

        @param width	[in]: the new window width
        @param height	[in]: the new window height

        @return <CODE>TRUE</CODE> on success
     */
    boolean setWindowSize( [in] long width, [in] long heigth ); 
 
    //------------------------------------------------------------------------- 
     
 
    // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::showStatusMessage
    /** Show status / hint message in browser's message area.

        @param message	[in]: the string to be displayed
     */
    [oneway] void showStatusMessage( [in] string message ); 
 
    //------------------------------------------------------------------------- 
     
 
    // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::enableScripting
    /** Indicates to the plugin that the document was loaded successfully and scripting
        interfaces are now available.

        @param document			[in]: the active document
        @param servicemanager	[in]: the office servicemanager

     */
    [oneway] void enableScripting( [in] com::sun::star::uno::XInterface document, [in] com::sun::star::lang::XMultiServiceFactory servicemanager ); 
 
    //------------------------------------------------------------------------- 
     
 
    // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::newStream
    /** Creates a new stream of data produced by the plug-in and consumed by
        the browser.

        @param MIMEDesc	[in]:	the MIME type of the plug-in to create
        @param target	[in]:	the name of the target window or frame (supports _blank, _self)
        @param data		[in]:	on success the outputstream will be	associated with this instance

     */
    [oneway] void newStream( 
        [in] string MIMEDesc, 
        [in] string target, 
        [in] com::sun::star::io::XActiveDataSource data 
    ); 
 
    //------------------------------------------------------------------------- 
     
 
    // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::getURL
    /** Fetches an URL into the target window. The parameters and their meaning map to the 
        corresponding Netscape-API call.
        
        @param aURL				[in]: the URL to be fetched
        @param target			[in]: the name of the target window or frame (supports _blank, _self)
        @param alternativeHost	[in]: alternativeHost 
        @param referrer			[in]: referrer
        @param sink				[in]: the sink is notified on success

     */
    [oneway] void getURL ( 
        [in] string aURL, 
        [in] string target, 
        [in] string alternativeHost, 
        [in] string referrer, 
        [in] XPluginInstanceNotifySink sink 
    ); 
 
    //------------------------------------------------------------------------- 
     
 
    // DocMerge from xml: method com::sun::star::mozilla::XPluginInstancePeer::postURL
    /** Posts to a URL with post data and/or post headers. The parameters and their meaning 
        map to the corresponding Netscape-API call.

        @param aURL				[in]: the URL to be posted to
        @param postData			[in]: the data to be posted
        @param target			[in]: the name of the target window or frame (supports _blank, _self)
        @param alternativeHost	[in]: alternativeHost 
        @param referrer			[in]: referrer
        @param postHeaders		[in]: the header to be posted
        @param sink				[in]: the sink is notified on success

     */
    [oneway] void postURL ( 
        [in] string aURL, 
        [in] com::sun::star::io::XInputStream postData, 
        [in] string target, 
        [in] string alternativeHost, 
        [in] string referrer, 
        [in] com::sun::star::io::XInputStream postHeaders, 
        [in] XPluginInstanceNotifySink sink 
    ); 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.5.14.1  2002/06/27 10:50:23  mav
    fix comments
    
    Revision 1.5  2001/04/25 16:09:34  ssa
    #83025# documentation update
    
    Revision 1.4  2001/03/16 16:41:29  jsc
    remove interfaceheader with uik and remove [const] in method definitions
    
    Revision 1.3  2000/11/08 12:43:25  mi
    moved from api
    
    Revision 1.1.1.1  2000/09/18 23:35:28  hjs
    initial import
    
    Revision 1.6  2000/09/11 11:52:34  mi
    documentation merged from XML
     
    Revision 1.4  2000/08/04 09:55:47  as 
    new parameter for enableScripting 
     
    Revision 1.3  2000/06/29 16:05:45  obr 
    interfaces splitted 
 
    Revision 1.2  2000/06/29 05:45:17  obr 
    api redesign 
 
    Revision 1.1  2000/06/19 09:36:45  obr 
    initial release 
 
 
=============================================================================*/ 
#endif