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

eric ide

mercurial