eric7/Documentation/Source/eric7.WebBrowser.Network.ProtocolHandlerManager.html

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

eric ide

mercurial