Documentation/Source/eric5.Helpviewer.HelpDocsInstaller.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Helpviewer.HelpDocsInstaller</title>
<style>
body {
    background: white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: black; background: #C1BBA4; }
h4 { color: black; background: #C1BBA4; }
    
a { color: #C07037; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Helpviewer.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><h4>Signals</h4>
<dl>
<dt>docsInstalled(bool)</dt>
<dd>
emitted after the installation has finished
</dd><dt>errorMessage(const QString&)</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>Methods</h3>
<table>
<tr>
<td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HelpDocsInstaller.__installEric5Doc">__installEric5Doc</a></td>
<td>Private method to install/update the eric5 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>Protected 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>
<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></dt>
<dd>
full pathname of the collection file (string)
</dd>
</dl><a NAME="HelpDocsInstaller.__installEric5Doc" ID="HelpDocsInstaller.__installEric5Doc"></a>
<h4>HelpDocsInstaller.__installEric5Doc</h4>
<b>__installEric5Doc</b>(<i>engine</i>)
<p>
        Private method to install/update the eric5 help documentation.
</p><dl>
<dt><i>engine</i></dt>
<dd>
reference to the help engine (QHelpEngineCore)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</dd>
</dl><a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a>
<h4>HelpDocsInstaller.__installQtDoc</h4>
<b>__installQtDoc</b>(<i>name, engine</i>)
<p>
        Private method to install/update a Qt help document.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the Qt help document (string)
</dd><dt><i>engine</i></dt>
<dd>
reference to the help engine (QHelpEngineCore)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</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>
        Protected 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>