|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.Network.ProtocolHandlerManager</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.WebBrowser.Network.ProtocolHandlerManager</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the protocol handler manager. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#ProtocolHandlerManager">ProtocolHandlerManager</a></td> |
|
25 <td>Class implementing the protocol handler manager.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="ProtocolHandlerManager" ID="ProtocolHandlerManager"></a> |
|
36 <h2>ProtocolHandlerManager</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing the protocol handler manager. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QObject |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#ProtocolHandlerManager.__init__">ProtocolHandlerManager</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#ProtocolHandlerManager.__load">__load</a></td> |
|
63 <td>Private method to load the registered protocol handlers.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#ProtocolHandlerManager.__protocolHandlersFileName">__protocolHandlersFileName</a></td> |
|
67 <td>Private method to determine the protocol handlers file name.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#ProtocolHandlerManager.__registerHandler">__registerHandler</a></td> |
|
71 <td>Private method to register a protocol handler for a scheme.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#ProtocolHandlerManager.__save">__save</a></td> |
|
75 <td>Private method to save the protocol handlers.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#ProtocolHandlerManager.__unregisterHandler">__unregisterHandler</a></td> |
|
79 <td>Private method to unregister a protocol handler for a scheme.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#ProtocolHandlerManager.addProtocolHandler">addProtocolHandler</a></td> |
|
83 <td>Public method to add a protocol handler for a scheme.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#ProtocolHandlerManager.protocolHandler">protocolHandler</a></td> |
|
87 <td>Public method to get the protocol handler URL for a given scheme.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#ProtocolHandlerManager.protocolHandlers">protocolHandlers</a></td> |
|
91 <td>Public method to get the registered protocol handlers.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#ProtocolHandlerManager.removeProtocolHandler">removeProtocolHandler</a></td> |
|
95 <td>Public method to remove the protocol handler for a given scheme.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#ProtocolHandlerManager.showProtocolHandlerManagerDialog">showProtocolHandlerManagerDialog</a></td> |
|
99 <td>Public method to show the protocol handler manager dialog.</td> |
|
100 </tr> |
|
101 </table> |
|
102 <h3>Static Methods</h3> |
|
103 |
|
104 <table> |
|
105 <tr><td>None</td></tr> |
|
106 </table> |
|
107 |
|
108 <a NAME="ProtocolHandlerManager.__init__" ID="ProtocolHandlerManager.__init__"></a> |
|
109 <h4>ProtocolHandlerManager (Constructor)</h4> |
|
110 <b>ProtocolHandlerManager</b>(<i>parent=None</i>) |
|
111 |
|
112 <p> |
|
113 Constructor |
|
114 </p> |
|
115 <dl> |
|
116 |
|
117 <dt><i>parent</i> (QObject)</dt> |
|
118 <dd> |
|
119 reference to the parent object |
|
120 </dd> |
|
121 </dl> |
|
122 <a NAME="ProtocolHandlerManager.__load" ID="ProtocolHandlerManager.__load"></a> |
|
123 <h4>ProtocolHandlerManager.__load</h4> |
|
124 <b>__load</b>(<i></i>) |
|
125 |
|
126 <p> |
|
127 Private method to load the registered protocol handlers. |
|
128 </p> |
|
129 <a NAME="ProtocolHandlerManager.__protocolHandlersFileName" ID="ProtocolHandlerManager.__protocolHandlersFileName"></a> |
|
130 <h4>ProtocolHandlerManager.__protocolHandlersFileName</h4> |
|
131 <b>__protocolHandlersFileName</b>(<i></i>) |
|
132 |
|
133 <p> |
|
134 Private method to determine the protocol handlers file name. |
|
135 </p> |
|
136 <dl> |
|
137 <dt>Return:</dt> |
|
138 <dd> |
|
139 name of the protocol handlers file |
|
140 </dd> |
|
141 </dl> |
|
142 <dl> |
|
143 <dt>Return Type:</dt> |
|
144 <dd> |
|
145 str |
|
146 </dd> |
|
147 </dl> |
|
148 <a NAME="ProtocolHandlerManager.__registerHandler" ID="ProtocolHandlerManager.__registerHandler"></a> |
|
149 <h4>ProtocolHandlerManager.__registerHandler</h4> |
|
150 <b>__registerHandler</b>(<i>scheme, url</i>) |
|
151 |
|
152 <p> |
|
153 Private method to register a protocol handler for a scheme. |
|
154 </p> |
|
155 <dl> |
|
156 |
|
157 <dt><i>scheme</i> (str)</dt> |
|
158 <dd> |
|
159 scheme of the protocol handler |
|
160 </dd> |
|
161 <dt><i>url</i> (QUrl)</dt> |
|
162 <dd> |
|
163 URL of the protocol handler |
|
164 </dd> |
|
165 </dl> |
|
166 <a NAME="ProtocolHandlerManager.__save" ID="ProtocolHandlerManager.__save"></a> |
|
167 <h4>ProtocolHandlerManager.__save</h4> |
|
168 <b>__save</b>(<i></i>) |
|
169 |
|
170 <p> |
|
171 Private method to save the protocol handlers. |
|
172 </p> |
|
173 <a NAME="ProtocolHandlerManager.__unregisterHandler" ID="ProtocolHandlerManager.__unregisterHandler"></a> |
|
174 <h4>ProtocolHandlerManager.__unregisterHandler</h4> |
|
175 <b>__unregisterHandler</b>(<i>scheme, url</i>) |
|
176 |
|
177 <p> |
|
178 Private method to unregister a protocol handler for a scheme. |
|
179 </p> |
|
180 <dl> |
|
181 |
|
182 <dt><i>scheme</i> (str)</dt> |
|
183 <dd> |
|
184 scheme of the protocol handler |
|
185 </dd> |
|
186 <dt><i>url</i> (QUrl)</dt> |
|
187 <dd> |
|
188 URL of the protocol handler |
|
189 </dd> |
|
190 </dl> |
|
191 <a NAME="ProtocolHandlerManager.addProtocolHandler" ID="ProtocolHandlerManager.addProtocolHandler"></a> |
|
192 <h4>ProtocolHandlerManager.addProtocolHandler</h4> |
|
193 <b>addProtocolHandler</b>(<i>scheme, url</i>) |
|
194 |
|
195 <p> |
|
196 Public method to add a protocol handler for a scheme. |
|
197 </p> |
|
198 <dl> |
|
199 |
|
200 <dt><i>scheme</i> (str)</dt> |
|
201 <dd> |
|
202 scheme of the protocol handler |
|
203 </dd> |
|
204 <dt><i>url</i> (QUrl)</dt> |
|
205 <dd> |
|
206 URL of the protocol handler |
|
207 </dd> |
|
208 </dl> |
|
209 <a NAME="ProtocolHandlerManager.protocolHandler" ID="ProtocolHandlerManager.protocolHandler"></a> |
|
210 <h4>ProtocolHandlerManager.protocolHandler</h4> |
|
211 <b>protocolHandler</b>(<i>scheme</i>) |
|
212 |
|
213 <p> |
|
214 Public method to get the protocol handler URL for a given scheme. |
|
215 </p> |
|
216 <dl> |
|
217 |
|
218 <dt><i>scheme</i> (str)</dt> |
|
219 <dd> |
|
220 scheme to look for |
|
221 </dd> |
|
222 </dl> |
|
223 <dl> |
|
224 <dt>Return:</dt> |
|
225 <dd> |
|
226 protocol handler URL |
|
227 </dd> |
|
228 </dl> |
|
229 <dl> |
|
230 <dt>Return Type:</dt> |
|
231 <dd> |
|
232 QUrl |
|
233 </dd> |
|
234 </dl> |
|
235 <a NAME="ProtocolHandlerManager.protocolHandlers" ID="ProtocolHandlerManager.protocolHandlers"></a> |
|
236 <h4>ProtocolHandlerManager.protocolHandlers</h4> |
|
237 <b>protocolHandlers</b>(<i></i>) |
|
238 |
|
239 <p> |
|
240 Public method to get the registered protocol handlers. |
|
241 </p> |
|
242 <dl> |
|
243 <dt>Return:</dt> |
|
244 <dd> |
|
245 dictionary containing the registered protocol handlers |
|
246 </dd> |
|
247 </dl> |
|
248 <dl> |
|
249 <dt>Return Type:</dt> |
|
250 <dd> |
|
251 dict |
|
252 </dd> |
|
253 </dl> |
|
254 <a NAME="ProtocolHandlerManager.removeProtocolHandler" ID="ProtocolHandlerManager.removeProtocolHandler"></a> |
|
255 <h4>ProtocolHandlerManager.removeProtocolHandler</h4> |
|
256 <b>removeProtocolHandler</b>(<i>scheme</i>) |
|
257 |
|
258 <p> |
|
259 Public method to remove the protocol handler for a given scheme. |
|
260 </p> |
|
261 <dl> |
|
262 |
|
263 <dt><i>scheme</i> (str)</dt> |
|
264 <dd> |
|
265 scheme to remove |
|
266 </dd> |
|
267 </dl> |
|
268 <a NAME="ProtocolHandlerManager.showProtocolHandlerManagerDialog" ID="ProtocolHandlerManager.showProtocolHandlerManagerDialog"></a> |
|
269 <h4>ProtocolHandlerManager.showProtocolHandlerManagerDialog</h4> |
|
270 <b>showProtocolHandlerManagerDialog</b>(<i></i>) |
|
271 |
|
272 <p> |
|
273 Public method to show the protocol handler manager dialog. |
|
274 </p> |
|
275 <div align="right"><a href="#top">Up</a></div> |
|
276 <hr /> |
|
277 </body></html> |