Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.Network.ProtocolHandlerManager.html

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

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

Mercurial Repository: eric

eric ide

mercurial