src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog</h1> 9 <h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to configure safe browsing support. 11 Module implementing a dialog to configure safe browsing support.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#SafeBrowsingDialog">SafeBrowsingDialog</a></td> 22 <td><a href="#SafeBrowsingDialog">SafeBrowsingDialog</a></td>
25 <td>Class implementing a dialog to configure safe browsing support.</td> 23 <td>Class implementing a dialog to configure safe browsing support.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="SafeBrowsingDialog" ID="SafeBrowsingDialog"></a> 34 <a NAME="SafeBrowsingDialog" ID="SafeBrowsingDialog"></a>
36 <h2>SafeBrowsingDialog</h2> 35 <h2>SafeBrowsingDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to configure safe browsing support. 37 Class implementing a dialog to configure safe browsing support.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_SafeBrowsingDialog 41 QDialog, Ui_SafeBrowsingDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#SafeBrowsingDialog.__init__">SafeBrowsingDialog</a></td> 55 <td><a href="#SafeBrowsingDialog.__init__">SafeBrowsingDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
125 <tr> 122 <tr>
126 <td><a href="#SafeBrowsingDialog.show">show</a></td> 123 <td><a href="#SafeBrowsingDialog.show">show</a></td>
127 <td>Public slot to show the dialog.</td> 124 <td>Public slot to show the dialog.</td>
128 </tr> 125 </tr>
129 </table> 126 </table>
127
130 <h3>Static Methods</h3> 128 <h3>Static Methods</h3>
131 129 <table>
132 <table> 130 <tr><td>None</td></tr>
133 <tr><td>None</td></tr> 131 </table>
134 </table> 132
135 133
136 <a NAME="SafeBrowsingDialog.__init__" ID="SafeBrowsingDialog.__init__"></a> 134 <a NAME="SafeBrowsingDialog.__init__" ID="SafeBrowsingDialog.__init__"></a>
137 <h4>SafeBrowsingDialog (Constructor)</h4> 135 <h4>SafeBrowsingDialog (Constructor)</h4>
138 <b>SafeBrowsingDialog</b>(<i>manager, parent=None</i>) 136 <b>SafeBrowsingDialog</b>(<i>manager, parent=None</i>)
139
140 <p> 137 <p>
141 Constructor 138 Constructor
142 </p> 139 </p>
140
143 <dl> 141 <dl>
144 142
145 <dt><i>manager</i> (SafeBrowsingManager)</dt> 143 <dt><i>manager</i> (SafeBrowsingManager)</dt>
146 <dd> 144 <dd>
147 reference to the safe browsing manager 145 reference to the safe browsing manager
152 </dd> 150 </dd>
153 </dl> 151 </dl>
154 <a NAME="SafeBrowsingDialog.__isModified" ID="SafeBrowsingDialog.__isModified"></a> 152 <a NAME="SafeBrowsingDialog.__isModified" ID="SafeBrowsingDialog.__isModified"></a>
155 <h4>SafeBrowsingDialog.__isModified</h4> 153 <h4>SafeBrowsingDialog.__isModified</h4>
156 <b>__isModified</b>(<i></i>) 154 <b>__isModified</b>(<i></i>)
157
158 <p> 155 <p>
159 Private method to check, if the dialog contains modified data. 156 Private method to check, if the dialog contains modified data.
160 </p> 157 </p>
158
161 <dl> 159 <dl>
162 <dt>Return:</dt> 160 <dt>Return:</dt>
163 <dd> 161 <dd>
164 flag indicating the presence of modified data 162 flag indicating the presence of modified data
165 </dd> 163 </dd>
171 </dd> 169 </dd>
172 </dl> 170 </dl>
173 <a NAME="SafeBrowsingDialog.__okToClose" ID="SafeBrowsingDialog.__okToClose"></a> 171 <a NAME="SafeBrowsingDialog.__okToClose" ID="SafeBrowsingDialog.__okToClose"></a>
174 <h4>SafeBrowsingDialog.__okToClose</h4> 172 <h4>SafeBrowsingDialog.__okToClose</h4>
175 <b>__okToClose</b>(<i></i>) 173 <b>__okToClose</b>(<i></i>)
176
177 <p> 174 <p>
178 Private method to check, if it is safe to close the dialog. 175 Private method to check, if it is safe to close the dialog.
179 </p> 176 </p>
177
180 <dl> 178 <dl>
181 <dt>Return:</dt> 179 <dt>Return:</dt>
182 <dd> 180 <dd>
183 flag indicating safe to close 181 flag indicating safe to close
184 </dd> 182 </dd>
190 </dd> 188 </dd>
191 </dl> 189 </dl>
192 <a NAME="SafeBrowsingDialog.__resetProgress" ID="SafeBrowsingDialog.__resetProgress"></a> 190 <a NAME="SafeBrowsingDialog.__resetProgress" ID="SafeBrowsingDialog.__resetProgress"></a>
193 <h4>SafeBrowsingDialog.__resetProgress</h4> 191 <h4>SafeBrowsingDialog.__resetProgress</h4>
194 <b>__resetProgress</b>(<i></i>) 192 <b>__resetProgress</b>(<i></i>)
195
196 <p> 193 <p>
197 Private method to reset the progress info. 194 Private method to reset the progress info.
198 </p> 195 </p>
196
199 <a NAME="SafeBrowsingDialog.__save" ID="SafeBrowsingDialog.__save"></a> 197 <a NAME="SafeBrowsingDialog.__save" ID="SafeBrowsingDialog.__save"></a>
200 <h4>SafeBrowsingDialog.__save</h4> 198 <h4>SafeBrowsingDialog.__save</h4>
201 <b>__save</b>(<i></i>) 199 <b>__save</b>(<i></i>)
202
203 <p> 200 <p>
204 Private slot to save the configuration. 201 Private slot to save the configuration.
205 </p> 202 </p>
203
206 <dl> 204 <dl>
207 <dt>Return:</dt> 205 <dt>Return:</dt>
208 <dd> 206 <dd>
209 flag indicating success 207 flag indicating success
210 </dd> 208 </dd>
216 </dd> 214 </dd>
217 </dl> 215 </dl>
218 <a NAME="SafeBrowsingDialog.__setProgress" ID="SafeBrowsingDialog.__setProgress"></a> 216 <a NAME="SafeBrowsingDialog.__setProgress" ID="SafeBrowsingDialog.__setProgress"></a>
219 <h4>SafeBrowsingDialog.__setProgress</h4> 217 <h4>SafeBrowsingDialog.__setProgress</h4>
220 <b>__setProgress</b>(<i>value</i>) 218 <b>__setProgress</b>(<i>value</i>)
221
222 <p> 219 <p>
223 Private slot to set the progress value. 220 Private slot to set the progress value.
224 </p> 221 </p>
222
225 <dl> 223 <dl>
226 224
227 <dt><i>value</i> (int)</dt> 225 <dt><i>value</i> (int)</dt>
228 <dd> 226 <dd>
229 progress value to be set 227 progress value to be set
230 </dd> 228 </dd>
231 </dl> 229 </dl>
232 <a NAME="SafeBrowsingDialog.__setProgressMessage" ID="SafeBrowsingDialog.__setProgressMessage"></a> 230 <a NAME="SafeBrowsingDialog.__setProgressMessage" ID="SafeBrowsingDialog.__setProgressMessage"></a>
233 <h4>SafeBrowsingDialog.__setProgressMessage</h4> 231 <h4>SafeBrowsingDialog.__setProgressMessage</h4>
234 <b>__setProgressMessage</b>(<i>message, maximum</i>) 232 <b>__setProgressMessage</b>(<i>message, maximum</i>)
235
236 <p> 233 <p>
237 Private slot to set the progress message and the maximum value. 234 Private slot to set the progress message and the maximum value.
238 </p> 235 </p>
236
239 <dl> 237 <dl>
240 238
241 <dt><i>message</i> (str)</dt> 239 <dt><i>message</i> (str)</dt>
242 <dd> 240 <dd>
243 progress message to be set 241 progress message to be set
248 </dd> 246 </dd>
249 </dl> 247 </dl>
250 <a NAME="SafeBrowsingDialog.__updateCacheButtons" ID="SafeBrowsingDialog.__updateCacheButtons"></a> 248 <a NAME="SafeBrowsingDialog.__updateCacheButtons" ID="SafeBrowsingDialog.__updateCacheButtons"></a>
251 <h4>SafeBrowsingDialog.__updateCacheButtons</h4> 249 <h4>SafeBrowsingDialog.__updateCacheButtons</h4>
252 <b>__updateCacheButtons</b>(<i></i>) 250 <b>__updateCacheButtons</b>(<i></i>)
253
254 <p> 251 <p>
255 Private method to set enabled state of the cache buttons. 252 Private method to set enabled state of the cache buttons.
256 </p> 253 </p>
254
257 <a NAME="SafeBrowsingDialog.closeEvent" ID="SafeBrowsingDialog.closeEvent"></a> 255 <a NAME="SafeBrowsingDialog.closeEvent" ID="SafeBrowsingDialog.closeEvent"></a>
258 <h4>SafeBrowsingDialog.closeEvent</h4> 256 <h4>SafeBrowsingDialog.closeEvent</h4>
259 <b>closeEvent</b>(<i>evt</i>) 257 <b>closeEvent</b>(<i>evt</i>)
260
261 <p> 258 <p>
262 Protected method to handle close events. 259 Protected method to handle close events.
263 </p> 260 </p>
261
264 <dl> 262 <dl>
265 263
266 <dt><i>evt</i> (QCloseEvent)</dt> 264 <dt><i>evt</i> (QCloseEvent)</dt>
267 <dd> 265 <dd>
268 reference to the close event 266 reference to the close event
269 </dd> 267 </dd>
270 </dl> 268 </dl>
271 <a NAME="SafeBrowsingDialog.on_buttonBox_clicked" ID="SafeBrowsingDialog.on_buttonBox_clicked"></a> 269 <a NAME="SafeBrowsingDialog.on_buttonBox_clicked" ID="SafeBrowsingDialog.on_buttonBox_clicked"></a>
272 <h4>SafeBrowsingDialog.on_buttonBox_clicked</h4> 270 <h4>SafeBrowsingDialog.on_buttonBox_clicked</h4>
273 <b>on_buttonBox_clicked</b>(<i>button</i>) 271 <b>on_buttonBox_clicked</b>(<i>button</i>)
274
275 <p> 272 <p>
276 Private slot called by a button of the button box clicked. 273 Private slot called by a button of the button box clicked.
277 </p> 274 </p>
275
278 <dl> 276 <dl>
279 277
280 <dt><i>button</i> (QAbstractButton)</dt> 278 <dt><i>button</i> (QAbstractButton)</dt>
281 <dd> 279 <dd>
282 button that was clicked 280 button that was clicked
283 </dd> 281 </dd>
284 </dl> 282 </dl>
285 <a NAME="SafeBrowsingDialog.on_clearCacheButton_clicked" ID="SafeBrowsingDialog.on_clearCacheButton_clicked"></a> 283 <a NAME="SafeBrowsingDialog.on_clearCacheButton_clicked" ID="SafeBrowsingDialog.on_clearCacheButton_clicked"></a>
286 <h4>SafeBrowsingDialog.on_clearCacheButton_clicked</h4> 284 <h4>SafeBrowsingDialog.on_clearCacheButton_clicked</h4>
287 <b>on_clearCacheButton_clicked</b>(<i></i>) 285 <b>on_clearCacheButton_clicked</b>(<i></i>)
288
289 <p> 286 <p>
290 Private slot to clear the local cache database. 287 Private slot to clear the local cache database.
291 </p> 288 </p>
289
292 <a NAME="SafeBrowsingDialog.on_gsbHelpButton_clicked" ID="SafeBrowsingDialog.on_gsbHelpButton_clicked"></a> 290 <a NAME="SafeBrowsingDialog.on_gsbHelpButton_clicked" ID="SafeBrowsingDialog.on_gsbHelpButton_clicked"></a>
293 <h4>SafeBrowsingDialog.on_gsbHelpButton_clicked</h4> 291 <h4>SafeBrowsingDialog.on_gsbHelpButton_clicked</h4>
294 <b>on_gsbHelpButton_clicked</b>(<i></i>) 292 <b>on_gsbHelpButton_clicked</b>(<i></i>)
295
296 <p> 293 <p>
297 Private slot to show some help text "How to create a safe 294 Private slot to show some help text "How to create a safe
298 browsing API key.". 295 browsing API key.".
299 </p> 296 </p>
297
300 <a NAME="SafeBrowsingDialog.on_saveButton_clicked" ID="SafeBrowsingDialog.on_saveButton_clicked"></a> 298 <a NAME="SafeBrowsingDialog.on_saveButton_clicked" ID="SafeBrowsingDialog.on_saveButton_clicked"></a>
301 <h4>SafeBrowsingDialog.on_saveButton_clicked</h4> 299 <h4>SafeBrowsingDialog.on_saveButton_clicked</h4>
302 <b>on_saveButton_clicked</b>(<i></i>) 300 <b>on_saveButton_clicked</b>(<i></i>)
303
304 <p> 301 <p>
305 Private slot to save the configuration data. 302 Private slot to save the configuration data.
306 </p> 303 </p>
304
307 <a NAME="SafeBrowsingDialog.on_showUpdateTimeButton_clicked" ID="SafeBrowsingDialog.on_showUpdateTimeButton_clicked"></a> 305 <a NAME="SafeBrowsingDialog.on_showUpdateTimeButton_clicked" ID="SafeBrowsingDialog.on_showUpdateTimeButton_clicked"></a>
308 <h4>SafeBrowsingDialog.on_showUpdateTimeButton_clicked</h4> 306 <h4>SafeBrowsingDialog.on_showUpdateTimeButton_clicked</h4>
309 <b>on_showUpdateTimeButton_clicked</b>(<i></i>) 307 <b>on_showUpdateTimeButton_clicked</b>(<i></i>)
310
311 <p> 308 <p>
312 Private slot to show the time of the next automatic threat list update. 309 Private slot to show the time of the next automatic threat list update.
313 </p> 310 </p>
311
314 <a NAME="SafeBrowsingDialog.on_updateCacheButton_clicked" ID="SafeBrowsingDialog.on_updateCacheButton_clicked"></a> 312 <a NAME="SafeBrowsingDialog.on_updateCacheButton_clicked" ID="SafeBrowsingDialog.on_updateCacheButton_clicked"></a>
315 <h4>SafeBrowsingDialog.on_updateCacheButton_clicked</h4> 313 <h4>SafeBrowsingDialog.on_updateCacheButton_clicked</h4>
316 <b>on_updateCacheButton_clicked</b>(<i></i>) 314 <b>on_updateCacheButton_clicked</b>(<i></i>)
317
318 <p> 315 <p>
319 Private slot to update the local cache database. 316 Private slot to update the local cache database.
320 </p> 317 </p>
318
321 <a NAME="SafeBrowsingDialog.on_urlCheckButton_clicked" ID="SafeBrowsingDialog.on_urlCheckButton_clicked"></a> 319 <a NAME="SafeBrowsingDialog.on_urlCheckButton_clicked" ID="SafeBrowsingDialog.on_urlCheckButton_clicked"></a>
322 <h4>SafeBrowsingDialog.on_urlCheckButton_clicked</h4> 320 <h4>SafeBrowsingDialog.on_urlCheckButton_clicked</h4>
323 <b>on_urlCheckButton_clicked</b>(<i></i>) 321 <b>on_urlCheckButton_clicked</b>(<i></i>)
324
325 <p> 322 <p>
326 Private slot to check the entered URL. 323 Private slot to check the entered URL.
327 </p> 324 </p>
325
328 <a NAME="SafeBrowsingDialog.on_urlEdit_textChanged" ID="SafeBrowsingDialog.on_urlEdit_textChanged"></a> 326 <a NAME="SafeBrowsingDialog.on_urlEdit_textChanged" ID="SafeBrowsingDialog.on_urlEdit_textChanged"></a>
329 <h4>SafeBrowsingDialog.on_urlEdit_textChanged</h4> 327 <h4>SafeBrowsingDialog.on_urlEdit_textChanged</h4>
330 <b>on_urlEdit_textChanged</b>(<i>text</i>) 328 <b>on_urlEdit_textChanged</b>(<i>text</i>)
331
332 <p> 329 <p>
333 Private slot to handle changes of the entered URL text. 330 Private slot to handle changes of the entered URL text.
334 </p> 331 </p>
332
335 <dl> 333 <dl>
336 334
337 <dt><i>text</i> (str)</dt> 335 <dt><i>text</i> (str)</dt>
338 <dd> 336 <dd>
339 entered URL text 337 entered URL text
340 </dd> 338 </dd>
341 </dl> 339 </dl>
342 <a NAME="SafeBrowsingDialog.show" ID="SafeBrowsingDialog.show"></a> 340 <a NAME="SafeBrowsingDialog.show" ID="SafeBrowsingDialog.show"></a>
343 <h4>SafeBrowsingDialog.show</h4> 341 <h4>SafeBrowsingDialog.show</h4>
344 <b>show</b>(<i></i>) 342 <b>show</b>(<i></i>)
345
346 <p> 343 <p>
347 Public slot to show the dialog. 344 Public slot to show the dialog.
348 </p> 345 </p>
346
349 <div align="right"><a href="#top">Up</a></div> 347 <div align="right"><a href="#top">Up</a></div>
350 <hr /> 348 <hr />
351 </body></html> 349 </body></html>

eric ide

mercurial