Documentation/Source/eric6.Preferences.ConfigurationPages.WebBrowserVirusTotalPage.html

changeset 6041
415d36b1d3a6
child 6382
4d6e43200bc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Preferences.ConfigurationPages.WebBrowserVirusTotalPage.html	Sat Dec 30 18:10:04 2017 +0100
@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Preferences.ConfigurationPages.WebBrowserVirusTotalPage</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>eric6.Preferences.ConfigurationPages.WebBrowserVirusTotalPage</h1>
+<p>
+Module implementing VirusTotal configuration page (web browser variant).
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#WebBrowserVirusTotalPage">WebBrowserVirusTotalPage</a></td>
+<td>Class implementing VirusTotal configuration page (web browser variant).</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#create">create</a></td>
+<td>Module function to create the configuration page.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="WebBrowserVirusTotalPage" ID="WebBrowserVirusTotalPage"></a>
+<h2>WebBrowserVirusTotalPage</h2>
+<p>
+    Class implementing VirusTotal configuration page (web browser variant).
+</p>
+<h3>Derived from</h3>
+ConfigurationPageBase, Ui_HelpVirusTotalPage
+<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="#WebBrowserVirusTotalPage.__init__">WebBrowserVirusTotalPage</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#WebBrowserVirusTotalPage.__checkServiceKeyFinished">__checkServiceKeyFinished</a></td>
+<td>Private slot to receive the result of the service key check.</td>
+</tr><tr>
+<td><a href="#WebBrowserVirusTotalPage.on_testButton_clicked">on_testButton_clicked</a></td>
+<td>Private slot to test the entered service key.</td>
+</tr><tr>
+<td><a href="#WebBrowserVirusTotalPage.on_vtServiceKeyEdit_textChanged">on_vtServiceKeyEdit_textChanged</a></td>
+<td>Private slot to handle changes of the service key.</td>
+</tr><tr>
+<td><a href="#WebBrowserVirusTotalPage.save">save</a></td>
+<td>Public slot to save the VirusTotal configuration.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="WebBrowserVirusTotalPage.__init__" ID="WebBrowserVirusTotalPage.__init__"></a>
+<h4>WebBrowserVirusTotalPage (Constructor)</h4>
+<b>WebBrowserVirusTotalPage</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="WebBrowserVirusTotalPage.__checkServiceKeyFinished" ID="WebBrowserVirusTotalPage.__checkServiceKeyFinished"></a>
+<h4>WebBrowserVirusTotalPage.__checkServiceKeyFinished</h4>
+<b>__checkServiceKeyFinished</b>(<i>result, msg</i>)
+<p>
+        Private slot to receive the result of the service key check.
+</p><dl>
+<dt><i>result</i></dt>
+<dd>
+flag indicating a successful check (boolean)
+</dd><dt><i>msg</i></dt>
+<dd>
+network error message (str)
+</dd>
+</dl><a NAME="WebBrowserVirusTotalPage.on_testButton_clicked" ID="WebBrowserVirusTotalPage.on_testButton_clicked"></a>
+<h4>WebBrowserVirusTotalPage.on_testButton_clicked</h4>
+<b>on_testButton_clicked</b>(<i></i>)
+<p>
+        Private slot to test the entered service key.
+</p><a NAME="WebBrowserVirusTotalPage.on_vtServiceKeyEdit_textChanged" ID="WebBrowserVirusTotalPage.on_vtServiceKeyEdit_textChanged"></a>
+<h4>WebBrowserVirusTotalPage.on_vtServiceKeyEdit_textChanged</h4>
+<b>on_vtServiceKeyEdit_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot to handle changes of the service key.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+entered service key (string)
+</dd>
+</dl><a NAME="WebBrowserVirusTotalPage.save" ID="WebBrowserVirusTotalPage.save"></a>
+<h4>WebBrowserVirusTotalPage.save</h4>
+<b>save</b>(<i></i>)
+<p>
+        Public slot to save the VirusTotal configuration.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="create" ID="create"></a>
+<h2>create</h2>
+<b>create</b>(<i>dlg</i>)
+<p>
+    Module function to create the configuration page.
+</p><dl>
+<dt><i>dlg</i></dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the instantiated page (ConfigurationPageBase)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial