--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,365 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingDialog</h1> + +<p> +Module implementing a dialog to configure safe browsing support. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#SafeBrowsingDialog">SafeBrowsingDialog</a></td> +<td>Class implementing a dialog to configure safe browsing support.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="SafeBrowsingDialog" ID="SafeBrowsingDialog"></a> +<h2>SafeBrowsingDialog</h2> + +<p> + Class implementing a dialog to configure safe browsing support. +</p> +<h3>Derived from</h3> +QDialog, Ui_SafeBrowsingDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#SafeBrowsingDialog.__init__">SafeBrowsingDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__isModified">__isModified</a></td> +<td>Private method to check, if the dialog contains modified data.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__okToClose">__okToClose</a></td> +<td>Private method to check, if it is safe to close the dialog.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__resetProgress">__resetProgress</a></td> +<td>Private method to reset the progress info.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__save">__save</a></td> +<td>Private slot to save the configuration.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__setProgress">__setProgress</a></td> +<td>Private slot to set the progress value.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__setProgressMessage">__setProgressMessage</a></td> +<td>Private slot to set the progress message and the maximum value.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.__updateCacheButtons">__updateCacheButtons</a></td> +<td>Private method to set enabled state of the cache buttons.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.closeEvent">closeEvent</a></td> +<td>Protected method to handle close events.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_clearCacheButton_clicked">on_clearCacheButton_clicked</a></td> +<td>Private slot to clear the local cache database.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_gsbHelpButton_clicked">on_gsbHelpButton_clicked</a></td> +<td>Private slot to show some help text "How to create a safe browsing API key.".</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> +<td>Private slot to save the configuration data.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_showUpdateTimeButton_clicked">on_showUpdateTimeButton_clicked</a></td> +<td>Private slot to show the time of the next automatic threat list update.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_updateCacheButton_clicked">on_updateCacheButton_clicked</a></td> +<td>Private slot to update the local cache database.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_urlCheckButton_clicked">on_urlCheckButton_clicked</a></td> +<td>Private slot to check the entered URL.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.on_urlEdit_textChanged">on_urlEdit_textChanged</a></td> +<td>Private slot to handle changes of the entered URL text.</td> +</tr> +<tr> +<td><a href="#SafeBrowsingDialog.show">show</a></td> +<td>Public slot to show the dialog.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="SafeBrowsingDialog.__init__" ID="SafeBrowsingDialog.__init__"></a> +<h4>SafeBrowsingDialog (Constructor)</h4> +<b>SafeBrowsingDialog</b>(<i>manager, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>manager</i> (SafeBrowsingManager)</dt> +<dd> +reference to the safe browsing manager +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="SafeBrowsingDialog.__isModified" ID="SafeBrowsingDialog.__isModified"></a> +<h4>SafeBrowsingDialog.__isModified</h4> +<b>__isModified</b>(<i></i>) + +<p> + Private method to check, if the dialog contains modified data. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the presence of modified data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="SafeBrowsingDialog.__okToClose" ID="SafeBrowsingDialog.__okToClose"></a> +<h4>SafeBrowsingDialog.__okToClose</h4> +<b>__okToClose</b>(<i></i>) + +<p> + Private method to check, if it is safe to close the dialog. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating safe to close +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="SafeBrowsingDialog.__resetProgress" ID="SafeBrowsingDialog.__resetProgress"></a> +<h4>SafeBrowsingDialog.__resetProgress</h4> +<b>__resetProgress</b>(<i></i>) + +<p> + Private method to reset the progress info. +</p> +<a NAME="SafeBrowsingDialog.__save" ID="SafeBrowsingDialog.__save"></a> +<h4>SafeBrowsingDialog.__save</h4> +<b>__save</b>(<i></i>) + +<p> + Private slot to save the configuration. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="SafeBrowsingDialog.__setProgress" ID="SafeBrowsingDialog.__setProgress"></a> +<h4>SafeBrowsingDialog.__setProgress</h4> +<b>__setProgress</b>(<i>value</i>) + +<p> + Private slot to set the progress value. +</p> +<dl> + +<dt><i>value</i> (int)</dt> +<dd> +progress value to be set +</dd> +</dl> +<a NAME="SafeBrowsingDialog.__setProgressMessage" ID="SafeBrowsingDialog.__setProgressMessage"></a> +<h4>SafeBrowsingDialog.__setProgressMessage</h4> +<b>__setProgressMessage</b>(<i>message, maximum</i>) + +<p> + Private slot to set the progress message and the maximum value. +</p> +<dl> + +<dt><i>message</i> (str)</dt> +<dd> +progress message to be set +</dd> +<dt><i>maximum</i> (int)</dt> +<dd> +maximum value to be set +</dd> +</dl> +<a NAME="SafeBrowsingDialog.__updateCacheButtons" ID="SafeBrowsingDialog.__updateCacheButtons"></a> +<h4>SafeBrowsingDialog.__updateCacheButtons</h4> +<b>__updateCacheButtons</b>(<i></i>) + +<p> + Private method to set enabled state of the cache buttons. +</p> +<a NAME="SafeBrowsingDialog.closeEvent" ID="SafeBrowsingDialog.closeEvent"></a> +<h4>SafeBrowsingDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected method to handle close events. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> +<a NAME="SafeBrowsingDialog.on_buttonBox_clicked" ID="SafeBrowsingDialog.on_buttonBox_clicked"></a> +<h4>SafeBrowsingDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot called by a button of the button box clicked. +</p> +<dl> + +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl> +<a NAME="SafeBrowsingDialog.on_clearCacheButton_clicked" ID="SafeBrowsingDialog.on_clearCacheButton_clicked"></a> +<h4>SafeBrowsingDialog.on_clearCacheButton_clicked</h4> +<b>on_clearCacheButton_clicked</b>(<i></i>) + +<p> + Private slot to clear the local cache database. +</p> +<a NAME="SafeBrowsingDialog.on_gsbHelpButton_clicked" ID="SafeBrowsingDialog.on_gsbHelpButton_clicked"></a> +<h4>SafeBrowsingDialog.on_gsbHelpButton_clicked</h4> +<b>on_gsbHelpButton_clicked</b>(<i></i>) + +<p> + Private slot to show some help text "How to create a safe + browsing API key.". +</p> +<a NAME="SafeBrowsingDialog.on_saveButton_clicked" ID="SafeBrowsingDialog.on_saveButton_clicked"></a> +<h4>SafeBrowsingDialog.on_saveButton_clicked</h4> +<b>on_saveButton_clicked</b>(<i></i>) + +<p> + Private slot to save the configuration data. +</p> +<a NAME="SafeBrowsingDialog.on_showUpdateTimeButton_clicked" ID="SafeBrowsingDialog.on_showUpdateTimeButton_clicked"></a> +<h4>SafeBrowsingDialog.on_showUpdateTimeButton_clicked</h4> +<b>on_showUpdateTimeButton_clicked</b>(<i></i>) + +<p> + Private slot to show the time of the next automatic threat list update. +</p> +<a NAME="SafeBrowsingDialog.on_updateCacheButton_clicked" ID="SafeBrowsingDialog.on_updateCacheButton_clicked"></a> +<h4>SafeBrowsingDialog.on_updateCacheButton_clicked</h4> +<b>on_updateCacheButton_clicked</b>(<i></i>) + +<p> + Private slot to update the local cache database. +</p> +<a NAME="SafeBrowsingDialog.on_urlCheckButton_clicked" ID="SafeBrowsingDialog.on_urlCheckButton_clicked"></a> +<h4>SafeBrowsingDialog.on_urlCheckButton_clicked</h4> +<b>on_urlCheckButton_clicked</b>(<i></i>) + +<p> + Private slot to check the entered URL. +</p> +<a NAME="SafeBrowsingDialog.on_urlEdit_textChanged" ID="SafeBrowsingDialog.on_urlEdit_textChanged"></a> +<h4>SafeBrowsingDialog.on_urlEdit_textChanged</h4> +<b>on_urlEdit_textChanged</b>(<i>text</i>) + +<p> + Private slot to handle changes of the entered URL text. +</p> +<dl> + +<dt><i>text</i> (str)</dt> +<dd> +entered URL text +</dd> +</dl> +<a NAME="SafeBrowsingDialog.show" ID="SafeBrowsingDialog.show"></a> +<h4>SafeBrowsingDialog.show</h4> +<b>show</b>(<i></i>) + +<p> + Public slot to show the dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file