Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkUrlInterceptor.html

eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkUrlInterceptor.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.NetworkUrlInterceptor</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.NetworkUrlInterceptor</h1>
24
25 <p>
26 Module implementing a class to handle URL requests before they get processed
27 by QtWebEngine.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#NetworkUrlInterceptor">NetworkUrlInterceptor</a></td>
40 <td>Class implementing an URL request handler.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="NetworkUrlInterceptor" ID="NetworkUrlInterceptor"></a>
51 <h2>NetworkUrlInterceptor</h2>
52
53 <p>
54 Class implementing an URL request handler.
55 </p>
56 <h3>Derived from</h3>
57 QWebEngineUrlRequestInterceptor
58 <h3>Class Attributes</h3>
59
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69
70 <table>
71
72 <tr>
73 <td><a href="#NetworkUrlInterceptor.__init__">NetworkUrlInterceptor</a></td>
74 <td>Constructor</td>
75 </tr>
76 <tr>
77 <td><a href="#NetworkUrlInterceptor.__loadSettings">__loadSettings</a></td>
78 <td>Private method to load the Network Manager settings.</td>
79 </tr>
80 <tr>
81 <td><a href="#NetworkUrlInterceptor.__potentiallyTrustworthy">__potentiallyTrustworthy</a></td>
82 <td>Private method to check, if the given URL is potentially trustworthy.</td>
83 </tr>
84 <tr>
85 <td><a href="#NetworkUrlInterceptor.__refererOrigin">__refererOrigin</a></td>
86 <td>Private method to generate an origin referer header URL.</td>
87 </tr>
88 <tr>
89 <td><a href="#NetworkUrlInterceptor.__sameOrigin">__sameOrigin</a></td>
90 <td>Private method to test the "same origin" policy.</td>
91 </tr>
92 <tr>
93 <td><a href="#NetworkUrlInterceptor.__setRefererHeader">__setRefererHeader</a></td>
94 <td>Private method to set the 'Referer' header depending on the configured rule set.</td>
95 </tr>
96 <tr>
97 <td><a href="#NetworkUrlInterceptor.__trimmedReferer">__trimmedReferer</a></td>
98 <td>Private method to generate the trimmed referer header URL.</td>
99 </tr>
100 <tr>
101 <td><a href="#NetworkUrlInterceptor.installUrlInterceptor">installUrlInterceptor</a></td>
102 <td>Public method to install an URL interceptor.</td>
103 </tr>
104 <tr>
105 <td><a href="#NetworkUrlInterceptor.interceptRequest">interceptRequest</a></td>
106 <td>Public method handling an URL request.</td>
107 </tr>
108 <tr>
109 <td><a href="#NetworkUrlInterceptor.preferencesChanged">preferencesChanged</a></td>
110 <td>Public slot to handle a change of preferences.</td>
111 </tr>
112 <tr>
113 <td><a href="#NetworkUrlInterceptor.removeUrlInterceptor">removeUrlInterceptor</a></td>
114 <td>Public method to remove an URL interceptor.</td>
115 </tr>
116 </table>
117 <h3>Static Methods</h3>
118
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122
123 <a NAME="NetworkUrlInterceptor.__init__" ID="NetworkUrlInterceptor.__init__"></a>
124 <h4>NetworkUrlInterceptor (Constructor)</h4>
125 <b>NetworkUrlInterceptor</b>(<i>parent=None</i>)
126
127 <p>
128 Constructor
129 </p>
130 <dl>
131
132 <dt><i>parent</i> (QObject)</dt>
133 <dd>
134 reference to the parent object
135 </dd>
136 </dl>
137 <a NAME="NetworkUrlInterceptor.__loadSettings" ID="NetworkUrlInterceptor.__loadSettings"></a>
138 <h4>NetworkUrlInterceptor.__loadSettings</h4>
139 <b>__loadSettings</b>(<i></i>)
140
141 <p>
142 Private method to load the Network Manager settings.
143 </p>
144 <a NAME="NetworkUrlInterceptor.__potentiallyTrustworthy" ID="NetworkUrlInterceptor.__potentiallyTrustworthy"></a>
145 <h4>NetworkUrlInterceptor.__potentiallyTrustworthy</h4>
146 <b>__potentiallyTrustworthy</b>(<i>url</i>)
147
148 <p>
149 Private method to check, if the given URL is potentially trustworthy.
150 </p>
151 <dl>
152
153 <dt><i>url</i> (QUrl)</dt>
154 <dd>
155 URL to be checked
156 </dd>
157 </dl>
158 <dl>
159 <dt>Return:</dt>
160 <dd>
161 flag indicating a potentially trustworthy URL
162 </dd>
163 </dl>
164 <dl>
165 <dt>Return Type:</dt>
166 <dd>
167 bool
168 </dd>
169 </dl>
170 <a NAME="NetworkUrlInterceptor.__refererOrigin" ID="NetworkUrlInterceptor.__refererOrigin"></a>
171 <h4>NetworkUrlInterceptor.__refererOrigin</h4>
172 <b>__refererOrigin</b>(<i>url</i>)
173
174 <p>
175 Private method to generate an origin referer header URL.
176 </p>
177 <dl>
178
179 <dt><i>url</i> (QUrl)</dt>
180 <dd>
181 URL to generate the header from
182 </dd>
183 </dl>
184 <dl>
185 <dt>Return:</dt>
186 <dd>
187 origin referer header URL
188 </dd>
189 </dl>
190 <dl>
191 <dt>Return Type:</dt>
192 <dd>
193 QByteArray or bytes
194 </dd>
195 </dl>
196 <a NAME="NetworkUrlInterceptor.__sameOrigin" ID="NetworkUrlInterceptor.__sameOrigin"></a>
197 <h4>NetworkUrlInterceptor.__sameOrigin</h4>
198 <b>__sameOrigin</b>(<i>url1, url2</i>)
199
200 <p>
201 Private method to test the "same origin" policy.
202 </p>
203 <dl>
204
205 <dt><i>url1</i> (QUrl)</dt>
206 <dd>
207 first URL for the test
208 </dd>
209 <dt><i>url2</i> (QUrl)</dt>
210 <dd>
211 second URL for the test
212 </dd>
213 </dl>
214 <dl>
215 <dt>Return:</dt>
216 <dd>
217 flag indicating that both URLs have the same origin
218 </dd>
219 </dl>
220 <dl>
221 <dt>Return Type:</dt>
222 <dd>
223 bool
224 </dd>
225 </dl>
226 <a NAME="NetworkUrlInterceptor.__setRefererHeader" ID="NetworkUrlInterceptor.__setRefererHeader"></a>
227 <h4>NetworkUrlInterceptor.__setRefererHeader</h4>
228 <b>__setRefererHeader</b>(<i>info</i>)
229
230 <p>
231 Private method to set the 'Referer' header depending on the configured
232 rule set.
233 </p>
234 <dl>
235
236 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
237 <dd>
238 URL request information
239 </dd>
240 </dl>
241 <dl>
242 <dt><b>See Also:</b></dt>
243
244 <dd>
245 <a href="https://wiki.mozilla.org/Security/Referrer"> Mozilla Referrer</a>
246 </dd>
247
248 <dd>
249 <a href="https://www.w3.org/TR/referrer-policy/"> W3C Referrer Policy</a>
250 </dd>
251 </dl>
252 <a NAME="NetworkUrlInterceptor.__trimmedReferer" ID="NetworkUrlInterceptor.__trimmedReferer"></a>
253 <h4>NetworkUrlInterceptor.__trimmedReferer</h4>
254 <b>__trimmedReferer</b>(<i>url</i>)
255
256 <p>
257 Private method to generate the trimmed referer header URL.
258 </p>
259 <dl>
260
261 <dt><i>url</i> (QUrl)</dt>
262 <dd>
263 URL to be trimmed as a referer header
264 </dd>
265 </dl>
266 <dl>
267 <dt>Return:</dt>
268 <dd>
269 trimmed referer header URL
270 </dd>
271 </dl>
272 <dl>
273 <dt>Return Type:</dt>
274 <dd>
275 QByteArray or bytes
276 </dd>
277 </dl>
278 <a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a>
279 <h4>NetworkUrlInterceptor.installUrlInterceptor</h4>
280 <b>installUrlInterceptor</b>(<i>interceptor</i>)
281
282 <p>
283 Public method to install an URL interceptor.
284 </p>
285 <dl>
286
287 <dt><i>interceptor</i> (UrlInterceptor)</dt>
288 <dd>
289 URL interceptor to be installed
290 </dd>
291 </dl>
292 <a NAME="NetworkUrlInterceptor.interceptRequest" ID="NetworkUrlInterceptor.interceptRequest"></a>
293 <h4>NetworkUrlInterceptor.interceptRequest</h4>
294 <b>interceptRequest</b>(<i>info</i>)
295
296 <p>
297 Public method handling an URL request.
298 </p>
299 <dl>
300
301 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
302 <dd>
303 URL request information
304 </dd>
305 </dl>
306 <a NAME="NetworkUrlInterceptor.preferencesChanged" ID="NetworkUrlInterceptor.preferencesChanged"></a>
307 <h4>NetworkUrlInterceptor.preferencesChanged</h4>
308 <b>preferencesChanged</b>(<i></i>)
309
310 <p>
311 Public slot to handle a change of preferences.
312 </p>
313 <a NAME="NetworkUrlInterceptor.removeUrlInterceptor" ID="NetworkUrlInterceptor.removeUrlInterceptor"></a>
314 <h4>NetworkUrlInterceptor.removeUrlInterceptor</h4>
315 <b>removeUrlInterceptor</b>(<i>interceptor</i>)
316
317 <p>
318 Public method to remove an URL interceptor.
319 </p>
320 <dl>
321
322 <dt><i>interceptor</i> (UrlInterceptor)</dt>
323 <dd>
324 URL interceptor to be removed
325 </dd>
326 </dl>
327 <div align="right"><a href="#top">Up</a></div>
328 <hr />
329 </body></html>

Mercurial Repository: eric

eric ide

mercurial