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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
////////////////////////////////////////////////////////////////////////////////
/**
* <B>INTERFACE TO NETSCAPE COMMUNICATOR PLUGINS (NEW C++ API).</B>
*
* <P>This superscedes the old plugin API (npapi.h, npupp.h), and
* eliminates the need for glue files: npunix.c, npwin.cpp and npmac.cpp that
* get linked with the plugin. You will however need to link with the "backward
* adapter" (badapter.cpp) in order to allow your plugin to run in pre-5.0
* browsers.
*
* <P>See nsplugin.h for an overview of how this interface fits with the
* overall plugin architecture.
*/
////////////////////////////////////////////////////////////////////////////////
#ifndef nsIPluginManager2_h___
#define nsIPluginManager2_h___
#include "nsIPluginManager.h"
////////////////////////////////////////////////////////////////////////////////
// Plugin Manager 2 Interface
// These extensions to nsIPluginManager are only available in Communicator 5.0.
class nsIPluginManager2 : public nsIPluginManager {
public:
/**
* Puts up a wait cursor.
*
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
BeginWaitCursor(void) = 0;
/**
* Restores the previous (non-wait) cursor.
*
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
EndWaitCursor(void) = 0;
/**
* Returns true if a URL protocol (e.g. "http") is supported.
*
* @param protocol - the protocol name
* @param result - true if the protocol is supported
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
SupportsURLProtocol(const char* protocol, PRBool *result) = 0;
/**
* This method may be called by the plugin to indicate that an error
* has occurred, e.g. that the plugin has failed or is shutting down
* spontaneously. This allows the browser to clean up any plugin-specific
* state.
*
* @param plugin - the plugin whose status is changing
* @param errorStatus - the the error status value
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
NotifyStatusChange(nsIPlugin* plugin, nsresult errorStatus) = 0;
/**
* Returns the proxy info for a given URL. The caller is required to
* free the resulting memory with nsIMalloc::Free. The result will be in the
* following format
*
* i) "DIRECT" -- no proxy
* ii) "PROXY xxx.xxx.xxx.xxx" -- use proxy
* iii) "SOCKS xxx.xxx.xxx.xxx" -- use SOCKS
* iv) Mixed. e.g. "PROXY 111.111.111.111;PROXY 112.112.112.112",
* "PROXY 111.111.111.111;SOCKS 112.112.112.112"....
*
* Which proxy/SOCKS to use is determined by the plugin.
*/
NS_IMETHOD
FindProxyForURL(const char* url, char* *result) = 0;
////////////////////////////////////////////////////////////////////////////
// New top-level window handling calls for Mac:
/**
* Registers a top-level window with the browser. Events received by that
* window will be dispatched to the event handler specified.
*
* @param handler - the event handler for the window
* @param window - the platform window reference
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
RegisterWindow(nsIEventHandler* handler, nsPluginPlatformWindowRef window) = 0;
/**
* Unregisters a top-level window with the browser. The handler and window pair
* should be the same as that specified to RegisterWindow.
*
* @param handler - the event handler for the window
* @param window - the platform window reference
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
UnregisterWindow(nsIEventHandler* handler, nsPluginPlatformWindowRef window) = 0;
/**
* Allocates a new menu ID (for the Mac).
*
* @param handler - the event handler for the window
* @param isSubmenu - whether this is a sub-menu ID or not
* @param result - the resulting menu ID
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
AllocateMenuID(nsIEventHandler* handler, PRBool isSubmenu, PRInt16 *result) = 0;
/**
* Deallocates a menu ID (for the Mac).
*
* @param handler - the event handler for the window
* @param menuID - the menu ID
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
DeallocateMenuID(nsIEventHandler* handler, PRInt16 menuID) = 0;
/**
* Indicates whether this event handler has allocated the given menu ID.
*
* @param handler - the event handler for the window
* @param menuID - the menu ID
* @param result - returns PR_TRUE if the menu ID is allocated
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
HasAllocatedMenuID(nsIEventHandler* handler, PRInt16 menuID, PRBool *result) = 0;
#if 0 // problematic
/**
* This operation causes the next browser event to be processed. This is
* handy for implement nested event loops where some other activity must
* be performed each time around the loop.
*
* On the Mac (and most likely on Win16), network activity can only occur on
* the main thread. Therefore, we provide a hook here for the case that the
* main thread needs to process events while waiting for network activity to
* complete.
*
* @param bEventHandled - a boolean indicating whether an event was processed on the
* main thread. If not on the main browser thread, PR_FALSE is returned.
* @result - NS_OK if this operation was successful
*/
NS_IMETHOD
ProcessNextEvent(PRBool *bEventHandled) = 0;
#endif
};
#define NS_IPLUGINMANAGER2_IID \
{ /* d2962dc0-4eb6-11d2-8164-006008119d7a */ \
0xd2962dc0, \
0x4eb6, \
0x11d2, \
{0x81, 0x64, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
}
////////////////////////////////////////////////////////////////////////////////
#endif /* nsIPluginManager2_h___ */
|
