|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog</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.SafeBrowsing.SafeBrowsingDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to configure safe browsing support. |
|
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="#SafeBrowsingDialog">SafeBrowsingDialog</a></td> |
|
25 <td>Class implementing a dialog to configure safe browsing support.</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="SafeBrowsingDialog" ID="SafeBrowsingDialog"></a> |
|
36 <h2>SafeBrowsingDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to configure safe browsing support. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QDialog, Ui_SafeBrowsingDialog |
|
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="#SafeBrowsingDialog.__init__">SafeBrowsingDialog</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#SafeBrowsingDialog.__isModified">__isModified</a></td> |
|
63 <td>Private method to check, if the dialog contains modified data.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#SafeBrowsingDialog.__okToClose">__okToClose</a></td> |
|
67 <td>Private method to check, if it is safe to close the dialog.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#SafeBrowsingDialog.__resetProgress">__resetProgress</a></td> |
|
71 <td>Private method to reset the progress info.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#SafeBrowsingDialog.__save">__save</a></td> |
|
75 <td>Private slot to save the configuration.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#SafeBrowsingDialog.__setProgress">__setProgress</a></td> |
|
79 <td>Private slot to set the progress value.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#SafeBrowsingDialog.__setProgressMessage">__setProgressMessage</a></td> |
|
83 <td>Private slot to set the progress message and the maximum value.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#SafeBrowsingDialog.__updateCacheButtons">__updateCacheButtons</a></td> |
|
87 <td>Private method to set enabled state of the cache buttons.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#SafeBrowsingDialog.closeEvent">closeEvent</a></td> |
|
91 <td>Protected method to handle close events.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#SafeBrowsingDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
95 <td>Private slot called by a button of the button box clicked.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#SafeBrowsingDialog.on_clearCacheButton_clicked">on_clearCacheButton_clicked</a></td> |
|
99 <td>Private slot to clear the local cache database.</td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td><a href="#SafeBrowsingDialog.on_gsbHelpButton_clicked">on_gsbHelpButton_clicked</a></td> |
|
103 <td>Private slot to show some help text "How to create a safe browsing API key.".</td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td><a href="#SafeBrowsingDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
|
107 <td>Private slot to save the configuration data.</td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td><a href="#SafeBrowsingDialog.on_showUpdateTimeButton_clicked">on_showUpdateTimeButton_clicked</a></td> |
|
111 <td>Private slot to show the time of the next automatic threat list update.</td> |
|
112 </tr> |
|
113 <tr> |
|
114 <td><a href="#SafeBrowsingDialog.on_updateCacheButton_clicked">on_updateCacheButton_clicked</a></td> |
|
115 <td>Private slot to update the local cache database.</td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td><a href="#SafeBrowsingDialog.on_urlCheckButton_clicked">on_urlCheckButton_clicked</a></td> |
|
119 <td>Private slot to check the entered URL.</td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td><a href="#SafeBrowsingDialog.on_urlEdit_textChanged">on_urlEdit_textChanged</a></td> |
|
123 <td>Private slot to handle changes of the entered URL text.</td> |
|
124 </tr> |
|
125 <tr> |
|
126 <td><a href="#SafeBrowsingDialog.show">show</a></td> |
|
127 <td>Public slot to show the dialog.</td> |
|
128 </tr> |
|
129 </table> |
|
130 <h3>Static Methods</h3> |
|
131 |
|
132 <table> |
|
133 <tr><td>None</td></tr> |
|
134 </table> |
|
135 |
|
136 <a NAME="SafeBrowsingDialog.__init__" ID="SafeBrowsingDialog.__init__"></a> |
|
137 <h4>SafeBrowsingDialog (Constructor)</h4> |
|
138 <b>SafeBrowsingDialog</b>(<i>manager, parent=None</i>) |
|
139 |
|
140 <p> |
|
141 Constructor |
|
142 </p> |
|
143 <dl> |
|
144 |
|
145 <dt><i>manager</i> (SafeBrowsingManager)</dt> |
|
146 <dd> |
|
147 reference to the safe browsing manager |
|
148 </dd> |
|
149 <dt><i>parent</i> (QWidget)</dt> |
|
150 <dd> |
|
151 reference to the parent widget |
|
152 </dd> |
|
153 </dl> |
|
154 <a NAME="SafeBrowsingDialog.__isModified" ID="SafeBrowsingDialog.__isModified"></a> |
|
155 <h4>SafeBrowsingDialog.__isModified</h4> |
|
156 <b>__isModified</b>(<i></i>) |
|
157 |
|
158 <p> |
|
159 Private method to check, if the dialog contains modified data. |
|
160 </p> |
|
161 <dl> |
|
162 <dt>Return:</dt> |
|
163 <dd> |
|
164 flag indicating the presence of modified data |
|
165 </dd> |
|
166 </dl> |
|
167 <dl> |
|
168 <dt>Return Type:</dt> |
|
169 <dd> |
|
170 bool |
|
171 </dd> |
|
172 </dl> |
|
173 <a NAME="SafeBrowsingDialog.__okToClose" ID="SafeBrowsingDialog.__okToClose"></a> |
|
174 <h4>SafeBrowsingDialog.__okToClose</h4> |
|
175 <b>__okToClose</b>(<i></i>) |
|
176 |
|
177 <p> |
|
178 Private method to check, if it is safe to close the dialog. |
|
179 </p> |
|
180 <dl> |
|
181 <dt>Return:</dt> |
|
182 <dd> |
|
183 flag indicating safe to close |
|
184 </dd> |
|
185 </dl> |
|
186 <dl> |
|
187 <dt>Return Type:</dt> |
|
188 <dd> |
|
189 bool |
|
190 </dd> |
|
191 </dl> |
|
192 <a NAME="SafeBrowsingDialog.__resetProgress" ID="SafeBrowsingDialog.__resetProgress"></a> |
|
193 <h4>SafeBrowsingDialog.__resetProgress</h4> |
|
194 <b>__resetProgress</b>(<i></i>) |
|
195 |
|
196 <p> |
|
197 Private method to reset the progress info. |
|
198 </p> |
|
199 <a NAME="SafeBrowsingDialog.__save" ID="SafeBrowsingDialog.__save"></a> |
|
200 <h4>SafeBrowsingDialog.__save</h4> |
|
201 <b>__save</b>(<i></i>) |
|
202 |
|
203 <p> |
|
204 Private slot to save the configuration. |
|
205 </p> |
|
206 <dl> |
|
207 <dt>Return:</dt> |
|
208 <dd> |
|
209 flag indicating success |
|
210 </dd> |
|
211 </dl> |
|
212 <dl> |
|
213 <dt>Return Type:</dt> |
|
214 <dd> |
|
215 bool |
|
216 </dd> |
|
217 </dl> |
|
218 <a NAME="SafeBrowsingDialog.__setProgress" ID="SafeBrowsingDialog.__setProgress"></a> |
|
219 <h4>SafeBrowsingDialog.__setProgress</h4> |
|
220 <b>__setProgress</b>(<i>value</i>) |
|
221 |
|
222 <p> |
|
223 Private slot to set the progress value. |
|
224 </p> |
|
225 <dl> |
|
226 |
|
227 <dt><i>value</i> (int)</dt> |
|
228 <dd> |
|
229 progress value to be set |
|
230 </dd> |
|
231 </dl> |
|
232 <a NAME="SafeBrowsingDialog.__setProgressMessage" ID="SafeBrowsingDialog.__setProgressMessage"></a> |
|
233 <h4>SafeBrowsingDialog.__setProgressMessage</h4> |
|
234 <b>__setProgressMessage</b>(<i>message, maximum</i>) |
|
235 |
|
236 <p> |
|
237 Private slot to set the progress message and the maximum value. |
|
238 </p> |
|
239 <dl> |
|
240 |
|
241 <dt><i>message</i> (str)</dt> |
|
242 <dd> |
|
243 progress message to be set |
|
244 </dd> |
|
245 <dt><i>maximum</i> (int)</dt> |
|
246 <dd> |
|
247 maximum value to be set |
|
248 </dd> |
|
249 </dl> |
|
250 <a NAME="SafeBrowsingDialog.__updateCacheButtons" ID="SafeBrowsingDialog.__updateCacheButtons"></a> |
|
251 <h4>SafeBrowsingDialog.__updateCacheButtons</h4> |
|
252 <b>__updateCacheButtons</b>(<i></i>) |
|
253 |
|
254 <p> |
|
255 Private method to set enabled state of the cache buttons. |
|
256 </p> |
|
257 <a NAME="SafeBrowsingDialog.closeEvent" ID="SafeBrowsingDialog.closeEvent"></a> |
|
258 <h4>SafeBrowsingDialog.closeEvent</h4> |
|
259 <b>closeEvent</b>(<i>evt</i>) |
|
260 |
|
261 <p> |
|
262 Protected method to handle close events. |
|
263 </p> |
|
264 <dl> |
|
265 |
|
266 <dt><i>evt</i> (QCloseEvent)</dt> |
|
267 <dd> |
|
268 reference to the close event |
|
269 </dd> |
|
270 </dl> |
|
271 <a NAME="SafeBrowsingDialog.on_buttonBox_clicked" ID="SafeBrowsingDialog.on_buttonBox_clicked"></a> |
|
272 <h4>SafeBrowsingDialog.on_buttonBox_clicked</h4> |
|
273 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
274 |
|
275 <p> |
|
276 Private slot called by a button of the button box clicked. |
|
277 </p> |
|
278 <dl> |
|
279 |
|
280 <dt><i>button</i></dt> |
|
281 <dd> |
|
282 button that was clicked (QAbstractButton) |
|
283 </dd> |
|
284 </dl> |
|
285 <a NAME="SafeBrowsingDialog.on_clearCacheButton_clicked" ID="SafeBrowsingDialog.on_clearCacheButton_clicked"></a> |
|
286 <h4>SafeBrowsingDialog.on_clearCacheButton_clicked</h4> |
|
287 <b>on_clearCacheButton_clicked</b>(<i></i>) |
|
288 |
|
289 <p> |
|
290 Private slot to clear the local cache database. |
|
291 </p> |
|
292 <a NAME="SafeBrowsingDialog.on_gsbHelpButton_clicked" ID="SafeBrowsingDialog.on_gsbHelpButton_clicked"></a> |
|
293 <h4>SafeBrowsingDialog.on_gsbHelpButton_clicked</h4> |
|
294 <b>on_gsbHelpButton_clicked</b>(<i></i>) |
|
295 |
|
296 <p> |
|
297 Private slot to show some help text "How to create a safe |
|
298 browsing API key.". |
|
299 </p> |
|
300 <a NAME="SafeBrowsingDialog.on_saveButton_clicked" ID="SafeBrowsingDialog.on_saveButton_clicked"></a> |
|
301 <h4>SafeBrowsingDialog.on_saveButton_clicked</h4> |
|
302 <b>on_saveButton_clicked</b>(<i></i>) |
|
303 |
|
304 <p> |
|
305 Private slot to save the configuration data. |
|
306 </p> |
|
307 <a NAME="SafeBrowsingDialog.on_showUpdateTimeButton_clicked" ID="SafeBrowsingDialog.on_showUpdateTimeButton_clicked"></a> |
|
308 <h4>SafeBrowsingDialog.on_showUpdateTimeButton_clicked</h4> |
|
309 <b>on_showUpdateTimeButton_clicked</b>(<i></i>) |
|
310 |
|
311 <p> |
|
312 Private slot to show the time of the next automatic threat list update. |
|
313 </p> |
|
314 <a NAME="SafeBrowsingDialog.on_updateCacheButton_clicked" ID="SafeBrowsingDialog.on_updateCacheButton_clicked"></a> |
|
315 <h4>SafeBrowsingDialog.on_updateCacheButton_clicked</h4> |
|
316 <b>on_updateCacheButton_clicked</b>(<i></i>) |
|
317 |
|
318 <p> |
|
319 Private slot to update the local cache database. |
|
320 </p> |
|
321 <a NAME="SafeBrowsingDialog.on_urlCheckButton_clicked" ID="SafeBrowsingDialog.on_urlCheckButton_clicked"></a> |
|
322 <h4>SafeBrowsingDialog.on_urlCheckButton_clicked</h4> |
|
323 <b>on_urlCheckButton_clicked</b>(<i></i>) |
|
324 |
|
325 <p> |
|
326 Private slot to check the entered URL. |
|
327 </p> |
|
328 <a NAME="SafeBrowsingDialog.on_urlEdit_textChanged" ID="SafeBrowsingDialog.on_urlEdit_textChanged"></a> |
|
329 <h4>SafeBrowsingDialog.on_urlEdit_textChanged</h4> |
|
330 <b>on_urlEdit_textChanged</b>(<i>text</i>) |
|
331 |
|
332 <p> |
|
333 Private slot to handle changes of the entered URL text. |
|
334 </p> |
|
335 <dl> |
|
336 |
|
337 <dt><i>text</i> (str)</dt> |
|
338 <dd> |
|
339 entered URL text |
|
340 </dd> |
|
341 </dl> |
|
342 <a NAME="SafeBrowsingDialog.show" ID="SafeBrowsingDialog.show"></a> |
|
343 <h4>SafeBrowsingDialog.show</h4> |
|
344 <b>show</b>(<i></i>) |
|
345 |
|
346 <p> |
|
347 Public slot to show the dialog. |
|
348 </p> |
|
349 <div align="right"><a href="#top">Up</a></div> |
|
350 <hr /> |
|
351 </body></html> |