Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingDialog.html

changeset 5832
28f36b9c925f
child 5839
fe4d62e23908
equal deleted inserted replaced
5831:536d97e3f1a1 5832:28f36b9c925f
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_updateCacheButton_clicked">on_updateCacheButton_clicked</a></td>
100 <td>Private slot to update the local cache database.</td>
101 </tr><tr>
102 <td><a href="#SafeBrowsingDialog.on_urlCheckButton_clicked">on_urlCheckButton_clicked</a></td>
103 <td>Private slot to check the entered URL.</td>
104 </tr><tr>
105 <td><a href="#SafeBrowsingDialog.on_urlEdit_textChanged">on_urlEdit_textChanged</a></td>
106 <td>Private slot to handle changes of the entered URL text.</td>
107 </tr><tr>
108 <td><a href="#SafeBrowsingDialog.show">show</a></td>
109 <td>Public slot to show the dialog.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="SafeBrowsingDialog.__init__" ID="SafeBrowsingDialog.__init__"></a>
117 <h4>SafeBrowsingDialog (Constructor)</h4>
118 <b>SafeBrowsingDialog</b>(<i>manager, parent=None</i>)
119 <p>
120 Constructor
121 </p><dl>
122 <dt><i>manager</i> (SafeBrowsingManager)</dt>
123 <dd>
124 reference to the safe browsing manager
125 </dd><dt><i>parent</i> (QWidget)</dt>
126 <dd>
127 reference to the parent widget
128 </dd>
129 </dl><a NAME="SafeBrowsingDialog.__isModified" ID="SafeBrowsingDialog.__isModified"></a>
130 <h4>SafeBrowsingDialog.__isModified</h4>
131 <b>__isModified</b>(<i></i>)
132 <p>
133 Private method to check, if the dialog contains modified data.
134 </p><dl>
135 <dt>Returns:</dt>
136 <dd>
137 flag indicating the presence of modified data
138 </dd>
139 </dl><dl>
140 <dt>Return Type:</dt>
141 <dd>
142 bool
143 </dd>
144 </dl><a NAME="SafeBrowsingDialog.__okToClose" ID="SafeBrowsingDialog.__okToClose"></a>
145 <h4>SafeBrowsingDialog.__okToClose</h4>
146 <b>__okToClose</b>(<i></i>)
147 <p>
148 Private method to check, if it is safe to close the dialog.
149 </p><dl>
150 <dt>Returns:</dt>
151 <dd>
152 flag indicating safe to close
153 </dd>
154 </dl><dl>
155 <dt>Return Type:</dt>
156 <dd>
157 bool
158 </dd>
159 </dl><a NAME="SafeBrowsingDialog.__resetProgress" ID="SafeBrowsingDialog.__resetProgress"></a>
160 <h4>SafeBrowsingDialog.__resetProgress</h4>
161 <b>__resetProgress</b>(<i></i>)
162 <p>
163 Private method to reset the progress info.
164 </p><a NAME="SafeBrowsingDialog.__save" ID="SafeBrowsingDialog.__save"></a>
165 <h4>SafeBrowsingDialog.__save</h4>
166 <b>__save</b>(<i></i>)
167 <p>
168 Private slot to save the configuration.
169 </p><dl>
170 <dt>Returns:</dt>
171 <dd>
172 flag indicating success
173 </dd>
174 </dl><dl>
175 <dt>Return Type:</dt>
176 <dd>
177 bool
178 </dd>
179 </dl><a NAME="SafeBrowsingDialog.__setProgress" ID="SafeBrowsingDialog.__setProgress"></a>
180 <h4>SafeBrowsingDialog.__setProgress</h4>
181 <b>__setProgress</b>(<i>value</i>)
182 <p>
183 Private slot to set the progress value.
184 </p><dl>
185 <dt><i>value</i> (int)</dt>
186 <dd>
187 progress value to be set
188 </dd>
189 </dl><a NAME="SafeBrowsingDialog.__setProgressMessage" ID="SafeBrowsingDialog.__setProgressMessage"></a>
190 <h4>SafeBrowsingDialog.__setProgressMessage</h4>
191 <b>__setProgressMessage</b>(<i>message, maximum</i>)
192 <p>
193 Private slot to set the progress message and the maximum value.
194 </p><dl>
195 <dt><i>message</i> (str)</dt>
196 <dd>
197 progress message to be set
198 </dd><dt><i>maximum</i> (int)</dt>
199 <dd>
200 maximum value to be set
201 </dd>
202 </dl><a NAME="SafeBrowsingDialog.__updateCacheButtons" ID="SafeBrowsingDialog.__updateCacheButtons"></a>
203 <h4>SafeBrowsingDialog.__updateCacheButtons</h4>
204 <b>__updateCacheButtons</b>(<i></i>)
205 <p>
206 Private method to set enabled state of the cache buttons.
207 </p><a NAME="SafeBrowsingDialog.closeEvent" ID="SafeBrowsingDialog.closeEvent"></a>
208 <h4>SafeBrowsingDialog.closeEvent</h4>
209 <b>closeEvent</b>(<i>evt</i>)
210 <p>
211 Protected method to handle close events.
212 </p><dl>
213 <dt><i>evt</i> (QCloseEvent)</dt>
214 <dd>
215 reference to the close event
216 </dd>
217 </dl><a NAME="SafeBrowsingDialog.on_buttonBox_clicked" ID="SafeBrowsingDialog.on_buttonBox_clicked"></a>
218 <h4>SafeBrowsingDialog.on_buttonBox_clicked</h4>
219 <b>on_buttonBox_clicked</b>(<i>button</i>)
220 <p>
221 Private slot called by a button of the button box clicked.
222 </p><dl>
223 <dt><i>button</i></dt>
224 <dd>
225 button that was clicked (QAbstractButton)
226 </dd>
227 </dl><a NAME="SafeBrowsingDialog.on_clearCacheButton_clicked" ID="SafeBrowsingDialog.on_clearCacheButton_clicked"></a>
228 <h4>SafeBrowsingDialog.on_clearCacheButton_clicked</h4>
229 <b>on_clearCacheButton_clicked</b>(<i></i>)
230 <p>
231 Private slot to clear the local cache database.
232 </p><a NAME="SafeBrowsingDialog.on_gsbHelpButton_clicked" ID="SafeBrowsingDialog.on_gsbHelpButton_clicked"></a>
233 <h4>SafeBrowsingDialog.on_gsbHelpButton_clicked</h4>
234 <b>on_gsbHelpButton_clicked</b>(<i></i>)
235 <p>
236 Private slot to show some help text "How to create a safe
237 browsing API key.".
238 </p><a NAME="SafeBrowsingDialog.on_saveButton_clicked" ID="SafeBrowsingDialog.on_saveButton_clicked"></a>
239 <h4>SafeBrowsingDialog.on_saveButton_clicked</h4>
240 <b>on_saveButton_clicked</b>(<i></i>)
241 <p>
242 Private slot to save the configuration data.
243 </p><a NAME="SafeBrowsingDialog.on_updateCacheButton_clicked" ID="SafeBrowsingDialog.on_updateCacheButton_clicked"></a>
244 <h4>SafeBrowsingDialog.on_updateCacheButton_clicked</h4>
245 <b>on_updateCacheButton_clicked</b>(<i></i>)
246 <p>
247 Private slot to update the local cache database.
248 </p><a NAME="SafeBrowsingDialog.on_urlCheckButton_clicked" ID="SafeBrowsingDialog.on_urlCheckButton_clicked"></a>
249 <h4>SafeBrowsingDialog.on_urlCheckButton_clicked</h4>
250 <b>on_urlCheckButton_clicked</b>(<i></i>)
251 <p>
252 Private slot to check the entered URL.
253 </p><a NAME="SafeBrowsingDialog.on_urlEdit_textChanged" ID="SafeBrowsingDialog.on_urlEdit_textChanged"></a>
254 <h4>SafeBrowsingDialog.on_urlEdit_textChanged</h4>
255 <b>on_urlEdit_textChanged</b>(<i>text</i>)
256 <p>
257 Private slot to handle changes of the entered URL text.
258 </p><dl>
259 <dt><i>text</i> (str)</dt>
260 <dd>
261 entered URL text
262 </dd>
263 </dl><a NAME="SafeBrowsingDialog.show" ID="SafeBrowsingDialog.show"></a>
264 <h4>SafeBrowsingDialog.show</h4>
265 <b>show</b>(<i></i>)
266 <p>
267 Public slot to show the dialog.
268 </p>
269 <div align="right"><a href="#top">Up</a></div>
270 <hr />
271 </body></html>

eric ide

mercurial