Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.HelpDocsInstaller.html
Documentation/Source/eric6.Helpviewer.HelpDocsInstaller.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.HelpDocsInstaller</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.HelpDocsInstaller</h1> | |
| 23 <p> | |
| 24 Module implementing a thread class populating and updating the QtHelp | |
| 25 documentation database. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#HelpDocsInstaller">HelpDocsInstaller</a></td> | |
| 35 <td>Class implementing the worker thread populating and updating the QtHelp documentation database.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="HelpDocsInstaller" ID="HelpDocsInstaller"></a> | |
| 44 <h2>HelpDocsInstaller</h2> | |
| 45 <p> | |
| 46 Class implementing the worker thread populating and updating the QtHelp | |
| 47 documentation database. | |
| 48 </p><h3>Signals</h3> | |
| 49 <dl> | |
| 50 <dt>docsInstalled(bool)</dt> | |
| 51 <dd> | |
| 52 emitted after the installation has finished | |
| 53 </dd><dt>errorMessage(str)</dt> | |
| 54 <dd> | |
| 55 emitted, if an error occurred during | |
| 56 the installation of the documentation | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <h3>Derived from</h3> | |
| 60 QThread | |
| 61 <h3>Class Attributes</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Class Methods</h3> | |
| 66 <table> | |
| 67 <tr><td>None</td></tr> | |
| 68 </table> | |
| 69 <h3>Methods</h3> | |
| 70 <table> | |
| 71 <tr> | |
| 72 <td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HelpDocsInstaller.__installEric6Doc">__installEric6Doc</a></td> | |
| 76 <td>Private method to install/update the eric6 help documentation.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HelpDocsInstaller.__installQtDoc">__installQtDoc</a></td> | |
| 79 <td>Private method to install/update a Qt help document.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HelpDocsInstaller.installDocs">installDocs</a></td> | |
| 82 <td>Public method to start the installation procedure.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HelpDocsInstaller.run">run</a></td> | |
| 85 <td>Public method executed by the thread.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HelpDocsInstaller.stop">stop</a></td> | |
| 88 <td>Public slot to stop the installation procedure.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <a NAME="HelpDocsInstaller.__init__" ID="HelpDocsInstaller.__init__"></a> | |
| 96 <h4>HelpDocsInstaller (Constructor)</h4> | |
| 97 <b>HelpDocsInstaller</b>(<i>collection</i>) | |
| 98 <p> | |
| 99 Constructor | |
| 100 </p><dl> | |
| 101 <dt><i>collection</i></dt> | |
| 102 <dd> | |
| 103 full pathname of the collection file (string) | |
| 104 </dd> | |
| 105 </dl><a NAME="HelpDocsInstaller.__installEric6Doc" ID="HelpDocsInstaller.__installEric6Doc"></a> | |
| 106 <h4>HelpDocsInstaller.__installEric6Doc</h4> | |
| 107 <b>__installEric6Doc</b>(<i>engine</i>) | |
| 108 <p> | |
| 109 Private method to install/update the eric6 help documentation. | |
| 110 </p><dl> | |
| 111 <dt><i>engine</i></dt> | |
| 112 <dd> | |
| 113 reference to the help engine (QHelpEngineCore) | |
| 114 </dd> | |
| 115 </dl><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 flag indicating success (boolean) | |
| 119 </dd> | |
| 120 </dl><a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a> | |
| 121 <h4>HelpDocsInstaller.__installQtDoc</h4> | |
| 122 <b>__installQtDoc</b>(<i>name, version, engine</i>) | |
| 123 <p> | |
| 124 Private method to install/update a Qt help document. | |
| 125 </p><dl> | |
| 126 <dt><i>name</i></dt> | |
| 127 <dd> | |
| 128 name of the Qt help document (string) | |
| 129 </dd><dt><i>version</i></dt> | |
| 130 <dd> | |
| 131 Qt version of the help documens (integer) | |
| 132 </dd><dt><i>engine</i></dt> | |
| 133 <dd> | |
| 134 reference to the help engine (QHelpEngineCore) | |
| 135 </dd> | |
| 136 </dl><dl> | |
| 137 <dt>Returns:</dt> | |
| 138 <dd> | |
| 139 flag indicating success (boolean) | |
| 140 </dd> | |
| 141 </dl><a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a> | |
| 142 <h4>HelpDocsInstaller.installDocs</h4> | |
| 143 <b>installDocs</b>(<i></i>) | |
| 144 <p> | |
| 145 Public method to start the installation procedure. | |
| 146 </p><a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a> | |
| 147 <h4>HelpDocsInstaller.run</h4> | |
| 148 <b>run</b>(<i></i>) | |
| 149 <p> | |
| 150 Public method executed by the thread. | |
| 151 </p><a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a> | |
| 152 <h4>HelpDocsInstaller.stop</h4> | |
| 153 <b>stop</b>(<i></i>) | |
| 154 <p> | |
| 155 Public slot to stop the installation procedure. | |
| 156 </p> | |
| 157 <div align="right"><a href="#top">Up</a></div> | |
| 158 <hr /> | |
| 159 </body></html> |
