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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XPluginContext.idl,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_plugin_XPluginContext_idl__
#define __com_sun_star_plugin_XPluginContext_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_plugin_XPlugin_idl__
#include <com/sun/star/plugin/XPlugin.idl>
#endif
#ifndef __com_sun_star_plugin_PluginVariable_idl__
#include <com/sun/star/plugin/PluginVariable.idl>
#endif
#ifndef __com_sun_star_plugin_PluginException_idl__
#include <com/sun/star/plugin/PluginException.idl>
#endif
#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif
#ifndef __com_sun_star_io_XActiveDataSource_idl__
#include <com/sun/star/io/XActiveDataSource.idl>
#endif
//=============================================================================
module com { module sun { module star { module plugin {
//=============================================================================
/** Interface receiving calls from a plugin library.
A default context can be created using the <type>PluginManager</type>.
*/
published interface XPluginContext: com::sun::star::uno::XInterface
{
/** Requests global application parameters like display connection
on UNIX systems.
@param xPlugin
plugin
@param aVariable
variable
@return value
*/
string getValue( [in] com::sun::star::plugin::XPlugin xPlugin,
[in] com::sun::star::plugin::PluginVariable aVariable )
raises( com::sun::star::plugin::PluginException );
/** Requests a notification of completion of the operation on an URL.
@param plugin
plugin
@param url
url
@param target
target frame
@param listener
event listener
*/
void getURLNotify( [in] com::sun::star::plugin::XPlugin plugin,
[in] string url,
[in] string target,
[in] com::sun::star::lang::XEventListener listener )
raises( com::sun::star::plugin::PluginException );
/** Requests an URL to be loaded into the frame target.
@param plugin
plugin
@param url
url
@param target
target frame
*/
void getURL( [in] com::sun::star::plugin::XPlugin plugin,
[in] string url,
[in] string target )
raises( com::sun::star::plugin::PluginException );
/** Posts data from a buffer or file to an URL and receives a
notification upon completion.
@param plugin
plugin
@param url
url
@param target
target frame
@param buf
data
@param file
whether data is from file
@param listener
event listener
*/
void postURLNotify( [in] com::sun::star::plugin::XPlugin plugin,
[in] string url,
[in] string target,
[in] sequence<byte> buf,
[in] boolean file,
[in] com::sun::star::lang::XEventListener listener )
raises( com::sun::star::plugin::PluginException );
/** Posts data from a buffer or file to an URL.
@param plugin
plugin
@param url
url
@param target
target frame
@param buf
data
@param file
whether data is from file
*/
void postURL( [in] com::sun::star::plugin::XPlugin plugin,
[in] string url,
[in] string target,
[in] sequence<byte> buf,
[in] boolean file )
raises( com::sun::star::plugin::PluginException );
/** Requests a new stream that is created by the plugin and consumed
by the browser.
@param plugin
plugin
@param mimetype
mime type
@param target
target frame
@param aSource
data source
*/
void newStream( [in] com::sun::star::plugin::XPlugin plugin,
[in] string mimetype,
[in] string target,
[in] com::sun::star::io::XActiveDataSource aSource )
raises( com::sun::star::plugin::PluginException );
/** Displays a message in the browser status line.
@param plugin
plugin
@param message
message
*/
void displayStatusText( [in] com::sun::star::plugin::XPlugin plugin,
[in] string message )
raises( com::sun::star::plugin::PluginException );
/** Returns an application dependent identification string.
This is the same string that is transmitted by a browser to an http server.
@param plugin
plugin
@return id
*/
string getUserAgent( [in] com::sun::star::plugin::XPlugin plugin )
raises( com::sun::star::plugin::PluginException );
};
//=============================================================================
}; }; }; };
#endif
|
