diff -r b43e04854aba -r 2eee7a645cba src/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpDocsInstaller.html --- a/src/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpDocsInstaller.html Sun Jan 08 16:11:22 2023 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,200 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric7.WebBrowser.QtHelp.HelpDocsInstaller</title> -<meta charset="UTF-8"> -<link rel="stylesheet" href="styles.css"> -</head> -<body> -<a NAME="top" ID="top"></a> -<h1>eric7.WebBrowser.QtHelp.HelpDocsInstaller</h1> - -<p> -Module implementing a thread class populating and updating the QtHelp -documentation database. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#HelpDocsInstaller">HelpDocsInstaller</a></td> -<td>Class implementing the worker thread populating and updating the QtHelp documentation database.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> -<tr><td>None</td></tr> -</table> -<hr /> -<hr /> -<a NAME="HelpDocsInstaller" ID="HelpDocsInstaller"></a> -<h2>HelpDocsInstaller</h2> - -<p> - Class implementing the worker thread populating and updating the QtHelp - documentation database. -</p> -<h3>Signals</h3> -<dl> - -<dt>docsInstalled(bool)</dt> -<dd> -emitted after the installation has finished -</dd> -<dt>errorMessage(str)</dt> -<dd> -emitted, if an error occurred during - the installation of the documentation -</dd> -</dl> -<h3>Derived from</h3> -QThread -<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="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#HelpDocsInstaller.__installEric7Doc">__installEric7Doc</a></td> -<td>Private method to install/update the eric help documentation.</td> -</tr> -<tr> -<td><a href="#HelpDocsInstaller.__installQtDoc">__installQtDoc</a></td> -<td>Private method to install/update a Qt help document.</td> -</tr> -<tr> -<td><a href="#HelpDocsInstaller.installDocs">installDocs</a></td> -<td>Public method to start the installation procedure.</td> -</tr> -<tr> -<td><a href="#HelpDocsInstaller.run">run</a></td> -<td>Public method executed by the thread.</td> -</tr> -<tr> -<td><a href="#HelpDocsInstaller.stop">stop</a></td> -<td>Public slot to stop the installation procedure.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="HelpDocsInstaller.__init__" ID="HelpDocsInstaller.__init__"></a> -<h4>HelpDocsInstaller (Constructor)</h4> -<b>HelpDocsInstaller</b>(<i>collection</i>) - -<p> - Constructor -</p> -<dl> - -<dt><i>collection</i> (str)</dt> -<dd> -full pathname of the collection file -</dd> -</dl> -<a NAME="HelpDocsInstaller.__installEric7Doc" ID="HelpDocsInstaller.__installEric7Doc"></a> -<h4>HelpDocsInstaller.__installEric7Doc</h4> -<b>__installEric7Doc</b>(<i>engine</i>) - -<p> - Private method to install/update the eric help documentation. -</p> -<dl> - -<dt><i>engine</i> (QHelpEngineCore)</dt> -<dd> -reference to the help engine -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating success -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a> -<h4>HelpDocsInstaller.__installQtDoc</h4> -<b>__installQtDoc</b>(<i>name, version, engine</i>) - -<p> - Private method to install/update a Qt help document. -</p> -<dl> - -<dt><i>name</i> (str)</dt> -<dd> -name of the Qt help document -</dd> -<dt><i>version</i> (int)</dt> -<dd> -Qt version of the help documents -</dd> -<dt><i>engine</i> (QHelpEngineCore)</dt> -<dd> -reference to the help engine -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating success -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a> -<h4>HelpDocsInstaller.installDocs</h4> -<b>installDocs</b>(<i></i>) - -<p> - Public method to start the installation procedure. -</p> -<a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a> -<h4>HelpDocsInstaller.run</h4> -<b>run</b>(<i></i>) - -<p> - Public method executed by the thread. -</p> -<a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a> -<h4>HelpDocsInstaller.stop</h4> -<b>stop</b>(<i></i>) - -<p> - Public slot to stop the installation procedure. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file