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

eric ide

mercurial