eric6/Documentation/Source/eric6.Helpviewer.HelpDocsInstaller.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
--- a/eric6/Documentation/Source/eric6.Helpviewer.HelpDocsInstaller.html	Mon Sep 09 18:52:08 2019 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,159 +0,0 @@
-<!DOCTYPE html>
-<html><head>
-<title>eric6.Helpviewer.HelpDocsInstaller</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.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><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.__installEric6Doc">__installEric6Doc</a></td>
-<td>Private method to install/update the eric6 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></dt>
-<dd>
-full pathname of the collection file (string)
-</dd>
-</dl><a NAME="HelpDocsInstaller.__installEric6Doc" ID="HelpDocsInstaller.__installEric6Doc"></a>
-<h4>HelpDocsInstaller.__installEric6Doc</h4>
-<b>__installEric6Doc</b>(<i>engine</i>)
-<p>
-        Private method to install/update the eric6 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, version, 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>version</i></dt>
-<dd>
-Qt version of the help documens (integer)
-</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>
-        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

eric ide

mercurial