eric: comparison Documentation/Source/eric5.Helpviewer.HelpDocsInstaller.html

-:81326a94fdca
+:37f0444c3479
 </style>
 </head>
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Helpviewer.HelpDocsInstaller</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#116;&#104;&#114;&#101;&#97;&#100; &#99;&#108;&#97;&#115;&#115; &#112;&#111;&#112;&#117;&#108;&#97;&#116;&#105;&#110;&#103; &#97;&#110;&#100; &#117;&#112;&#100;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112;
+Module implementing a thread class populating and updating the QtHelp
-&#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.
+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>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; w&#111;&#114;&#107;&#101;&#114; &#116;&#104;&#114;&#101;&#97;&#100; &#112;&#111;&#112;&#117;&#108;&#97;&#116;&#105;&#110;&#103; &#97;&#110;&#100; &#117;&#112;&#100;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</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>
-&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; w&#111;&#114;&#107;&#101;&#114; &#116;&#104;&#114;&#101;&#97;&#100; &#112;&#111;&#112;&#117;&#108;&#97;&#116;&#105;&#110;&#103; &#97;&#110;&#100; &#117;&#112;&#100;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112;
+Class implementing the worker thread populating and updating the QtHelp
-&#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.
+documentation database.
 </p><h4>Signals</h4>
 <dl>
 <dt>docsInstalled(bool)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#104;&#97;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100;
+emitted after the installation has finished
 </dd><dt>errorMessage(const QString&)</dt>
 <dd>
-&#101;&#109;&#105;&#116;&#116;&#101;&#100;, &#105;&#102; &#97;&#110; &#101;&#114;&#114;&#111;&#114; &#111;&#99;&#99;&#117;&#114;&#114;&#101;&#100; &#100;&#117;&#114;&#105;&#110;&#103;
+emitted, if an error occurred during
-&#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;
+the installation of the documentation
 </dd>
 </dl>
 <h3>Derived from</h3>
 QThread
 <h3>Class Attributes</h3>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#HelpDocsInstaller.__installEric5Doc">__installEric5Doc</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#115;&#116;&#97;&#108;&#108;/&#117;&#112;&#100;&#97;&#116;&#101; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#53; &#104;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Private method to install/update the eric5 help documentation.</td>
 </tr><tr>
 <td><a href="#HelpDocsInstaller.__installQtDoc">__installQtDoc</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#115;&#116;&#97;&#108;&#108;/&#117;&#112;&#100;&#97;&#116;&#101; &#97; &#81;&#116; &#104;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to install/update a Qt help document.</td>
 </tr><tr>
 <td><a href="#HelpDocsInstaller.installDocs">installDocs</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#100;&#117;&#114;&#101;.</td>
+<td>Public method to start the installation procedure.</td>
 </tr><tr>
 <td><a href="#HelpDocsInstaller.run">run</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#101;x&#101;&#99;&#117;&#116;&#101;&#100; &#98;y &#116;&#104;&#101; &#116;&#104;&#114;&#101;&#97;&#100;.</td>
+<td>Protected method executed by the thread.</td>
 </tr><tr>
 <td><a href="#HelpDocsInstaller.stop">stop</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#111;&#112; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#100;&#117;&#114;&#101;.</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>
-&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+Constructor
 </p><dl>
 <dt><i>collection</i></dt>
 <dd>
-&#102;&#117;&#108;&#108; &#112;&#97;&#116;&#104;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#115;&#116;&#97;&#108;&#108;/&#117;&#112;&#100;&#97;&#116;&#101; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#53; &#104;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;.
+Private method to install/update the eric5 help documentation.
 </p><dl>
 <dt><i>engine</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#101;&#110;&#103;&#105;&#110;&#101; (&#81;&#72;&#101;&#108;&#112;&#69;&#110;&#103;&#105;&#110;&#101;&#67;&#111;&#114;&#101;)
+reference to the help engine (QHelpEngineCore)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;&#117;&#99;&#99;&#101;&#115;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#115;&#116;&#97;&#108;&#108;/&#117;&#112;&#100;&#97;&#116;&#101; &#97; &#81;&#116; &#104;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.
+Private method to install/update a Qt help document.
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#81;&#116; &#104;&#101;&#108;&#112; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the Qt help document (string)
 </dd><dt><i>engine</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#101;&#110;&#103;&#105;&#110;&#101; (&#81;&#72;&#101;&#108;&#112;&#69;&#110;&#103;&#105;&#110;&#101;&#67;&#111;&#114;&#101;)
+reference to the help engine (QHelpEngineCore)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;&#117;&#99;&#99;&#101;&#115;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating success (boolean)
 </dd>
 </dl><a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a>
 <h4>HelpDocsInstaller.installDocs</h4>
 <b>installDocs</b>(<i></i>)
 <p>
-&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#100;&#117;&#114;&#101;.
+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>
-&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#101;x&#101;&#99;&#117;&#116;&#101;&#100; &#98;y &#116;&#104;&#101; &#116;&#104;&#114;&#101;&#97;&#100;.
+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>
-&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#111;&#112; &#116;&#104;&#101; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#100;&#117;&#114;&#101;.
+Public slot to stop the installation procedure.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>

Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.HelpDocsInstaller.html

Documentation/Source/eric5.Helpviewer.HelpDocsInstaller.html