Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Network.NetworkUrlInterceptor</h1>
23 <p>
24 Module implementing a class to handle URL requests before they get processed
25 by QtWebEngine.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#NetworkUrlInterceptor">NetworkUrlInterceptor</a></td>
35 <td>Class implementing an URL request handler.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="NetworkUrlInterceptor" ID="NetworkUrlInterceptor"></a>
44 <h2>NetworkUrlInterceptor</h2>
45 <p>
46 Class implementing an URL request handler.
47 </p>
48 <h3>Derived from</h3>
49 QWebEngineUrlRequestInterceptor
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#NetworkUrlInterceptor.__init__">NetworkUrlInterceptor</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#NetworkUrlInterceptor.__loadSettings">__loadSettings</a></td>
65 <td>Private method to load the Network Manager settings.</td>
66 </tr><tr>
67 <td><a href="#NetworkUrlInterceptor.__potentiallyTrustworthy">__potentiallyTrustworthy</a></td>
68 <td>Private method to check, if the given URL is potentially trustworthy.</td>
69 </tr><tr>
70 <td><a href="#NetworkUrlInterceptor.__refererOrigin">__refererOrigin</a></td>
71 <td>Private method to generate an origin referer header URL.</td>
72 </tr><tr>
73 <td><a href="#NetworkUrlInterceptor.__sameOrigin">__sameOrigin</a></td>
74 <td>Private method to test the "same origin" policy.</td>
75 </tr><tr>
76 <td><a href="#NetworkUrlInterceptor.__setRefererHeader">__setRefererHeader</a></td>
77 <td>Private method to set the 'Referer' header depending on the configured rule set.</td>
78 </tr><tr>
79 <td><a href="#NetworkUrlInterceptor.__trimmedReferer">__trimmedReferer</a></td>
80 <td>Private method to generate the trimmed referer header URL.</td>
81 </tr><tr>
82 <td><a href="#NetworkUrlInterceptor.installUrlInterceptor">installUrlInterceptor</a></td>
83 <td>Public method to install an URL interceptor.</td>
84 </tr><tr>
85 <td><a href="#NetworkUrlInterceptor.interceptRequest">interceptRequest</a></td>
86 <td>Public method handling an URL request.</td>
87 </tr><tr>
88 <td><a href="#NetworkUrlInterceptor.preferencesChanged">preferencesChanged</a></td>
89 <td>Public slot to handle a change of preferences.</td>
90 </tr><tr>
91 <td><a href="#NetworkUrlInterceptor.removeUrlInterceptor">removeUrlInterceptor</a></td>
92 <td>Public method to remove an URL interceptor.</td>
93 </tr>
94 </table>
95 <h3>Static Methods</h3>
96 <table>
97 <tr><td>None</td></tr>
98 </table>
99 <a NAME="NetworkUrlInterceptor.__init__" ID="NetworkUrlInterceptor.__init__"></a>
100 <h4>NetworkUrlInterceptor (Constructor)</h4>
101 <b>NetworkUrlInterceptor</b>(<i>parent=None</i>)
102 <p>
103 Constructor
104 </p><dl>
105 <dt><i>parent</i> (QObject)</dt>
106 <dd>
107 reference to the parent object
108 </dd>
109 </dl><a NAME="NetworkUrlInterceptor.__loadSettings" ID="NetworkUrlInterceptor.__loadSettings"></a>
110 <h4>NetworkUrlInterceptor.__loadSettings</h4>
111 <b>__loadSettings</b>(<i></i>)
112 <p>
113 Private method to load the Network Manager settings.
114 </p><a NAME="NetworkUrlInterceptor.__potentiallyTrustworthy" ID="NetworkUrlInterceptor.__potentiallyTrustworthy"></a>
115 <h4>NetworkUrlInterceptor.__potentiallyTrustworthy</h4>
116 <b>__potentiallyTrustworthy</b>(<i>url</i>)
117 <p>
118 Private method to check, if the given URL is potentially trustworthy.
119 </p><dl>
120 <dt><i>url</i> (QUrl)</dt>
121 <dd>
122 URL to be checked
123 </dd>
124 </dl><dl>
125 <dt>Returns:</dt>
126 <dd>
127 flag indicating a potentially trustworthy URL
128 </dd>
129 </dl><dl>
130 <dt>Return Type:</dt>
131 <dd>
132 bool
133 </dd>
134 </dl><a NAME="NetworkUrlInterceptor.__refererOrigin" ID="NetworkUrlInterceptor.__refererOrigin"></a>
135 <h4>NetworkUrlInterceptor.__refererOrigin</h4>
136 <b>__refererOrigin</b>(<i>url</i>)
137 <p>
138 Private method to generate an origin referer header URL.
139 </p><dl>
140 <dt><i>url</i> (QUrl)</dt>
141 <dd>
142 URL to generate the header from
143 </dd>
144 </dl><dl>
145 <dt>Returns:</dt>
146 <dd>
147 origin referer header URL
148 </dd>
149 </dl><dl>
150 <dt>Return Type:</dt>
151 <dd>
152 QByteArray or bytes
153 </dd>
154 </dl><a NAME="NetworkUrlInterceptor.__sameOrigin" ID="NetworkUrlInterceptor.__sameOrigin"></a>
155 <h4>NetworkUrlInterceptor.__sameOrigin</h4>
156 <b>__sameOrigin</b>(<i>url1, url2</i>)
157 <p>
158 Private method to test the "same origin" policy.
159 </p><dl>
160 <dt><i>url1</i> (QUrl)</dt>
161 <dd>
162 first URL for the test
163 </dd><dt><i>url2</i> (QUrl)</dt>
164 <dd>
165 second URL for the test
166 </dd>
167 </dl><dl>
168 <dt>Returns:</dt>
169 <dd>
170 flag indicating that both URLs have the same origin
171 </dd>
172 </dl><dl>
173 <dt>Return Type:</dt>
174 <dd>
175 bool
176 </dd>
177 </dl><a NAME="NetworkUrlInterceptor.__setRefererHeader" ID="NetworkUrlInterceptor.__setRefererHeader"></a>
178 <h4>NetworkUrlInterceptor.__setRefererHeader</h4>
179 <b>__setRefererHeader</b>(<i>info</i>)
180 <p>
181 Private method to set the 'Referer' header depending on the configured
182 rule set.
183 </p><dl>
184 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
185 <dd>
186 URL request information
187 </dd>
188 </dl><dl>
189 <dt><b>See Also:</b></dt>
190 <dd>
191 <a href="https://wiki.mozilla.org/Security/Referrer"> Mozilla Referrer</a>
192 </dd>
193 <dd>
194 <a href="https://www.w3.org/TR/referrer-policy/"> W3C Referrer Policy</a>
195 </dd>
196 </dl><a NAME="NetworkUrlInterceptor.__trimmedReferer" ID="NetworkUrlInterceptor.__trimmedReferer"></a>
197 <h4>NetworkUrlInterceptor.__trimmedReferer</h4>
198 <b>__trimmedReferer</b>(<i>url</i>)
199 <p>
200 Private method to generate the trimmed referer header URL.
201 </p><dl>
202 <dt><i>url</i> (QUrl)</dt>
203 <dd>
204 URL to be trimmed as a referer header
205 </dd>
206 </dl><dl>
207 <dt>Returns:</dt>
208 <dd>
209 trimmed referer header URL
210 </dd>
211 </dl><dl>
212 <dt>Return Type:</dt>
213 <dd>
214 QByteArray or bytes
215 </dd>
216 </dl><a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a>
217 <h4>NetworkUrlInterceptor.installUrlInterceptor</h4>
218 <b>installUrlInterceptor</b>(<i>interceptor</i>)
219 <p>
220 Public method to install an URL interceptor.
221 </p><dl>
222 <dt><i>interceptor</i> (UrlInterceptor)</dt>
223 <dd>
224 URL interceptor to be installed
225 </dd>
226 </dl><a NAME="NetworkUrlInterceptor.interceptRequest" ID="NetworkUrlInterceptor.interceptRequest"></a>
227 <h4>NetworkUrlInterceptor.interceptRequest</h4>
228 <b>interceptRequest</b>(<i>info</i>)
229 <p>
230 Public method handling an URL request.
231 </p><dl>
232 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
233 <dd>
234 URL request information
235 </dd>
236 </dl><a NAME="NetworkUrlInterceptor.preferencesChanged" ID="NetworkUrlInterceptor.preferencesChanged"></a>
237 <h4>NetworkUrlInterceptor.preferencesChanged</h4>
238 <b>preferencesChanged</b>(<i></i>)
239 <p>
240 Public slot to handle a change of preferences.
241 </p><a NAME="NetworkUrlInterceptor.removeUrlInterceptor" ID="NetworkUrlInterceptor.removeUrlInterceptor"></a>
242 <h4>NetworkUrlInterceptor.removeUrlInterceptor</h4>
243 <b>removeUrlInterceptor</b>(<i>interceptor</i>)
244 <p>
245 Public method to remove an URL interceptor.
246 </p><dl>
247 <dt><i>interceptor</i> (UrlInterceptor)</dt>
248 <dd>
249 URL interceptor to be removed
250 </dd>
251 </dl>
252 <div align="right"><a href="#top">Up</a></div>
253 <hr />
254 </body></html>

Mercurial Repository: eric

eric ide

mercurial