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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_plugin_XPluginContext_idl__
#define __com_sun_star_plugin_XPluginContext_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/plugin/XPlugin.idl>
#include <com/sun/star/plugin/PluginVariable.idl>
#include <com/sun/star/plugin/PluginException.idl>
#include <com/sun/star/lang/XEventListener.idl>
#include <com/sun/star/io/XActiveDataSource.idl>
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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
