Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpDocsInstaller.html
eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpDocsInstaller.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8549
- 15eca21fd968
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.QtHelp.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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.WebBrowser.QtHelp.HelpDocsInstaller</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a thread class populating and updating the QtHelp | |
| 27 documentation database. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#HelpDocsInstaller">HelpDocsInstaller</a></td> | |
| 40 <td>Class implementing the worker thread populating and updating the QtHelp documentation database.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="HelpDocsInstaller" ID="HelpDocsInstaller"></a> | |
| 51 <h2>HelpDocsInstaller</h2> | |
| 52 | |
| 53 <p> | |
| 54 Class implementing the worker thread populating and updating the QtHelp | |
| 55 documentation database. | |
| 56 </p> | |
| 57 <h3>Signals</h3> | |
| 58 <dl> | |
| 59 | |
| 60 <dt>docsInstalled(bool)</dt> | |
| 61 <dd> | |
| 62 emitted after the installation has finished | |
| 63 </dd> | |
| 64 <dt>errorMessage(str)</dt> | |
| 65 <dd> | |
| 66 emitted, if an error occurred during | |
| 67 the installation of the documentation | |
| 68 </dd> | |
| 69 </dl> | |
| 70 <h3>Derived from</h3> | |
| 71 QThread | |
| 72 <h3>Class Attributes</h3> | |
| 73 | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <h3>Class Methods</h3> | |
| 78 | |
| 79 <table> | |
| 80 <tr><td>None</td></tr> | |
| 81 </table> | |
| 82 <h3>Methods</h3> | |
| 83 | |
| 84 <table> | |
| 85 | |
| 86 <tr> | |
| 87 <td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td> | |
| 88 <td>Constructor</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#HelpDocsInstaller.__installEric7Doc">__installEric7Doc</a></td> | |
| 92 <td>Private method to install/update the eric help documentation.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#HelpDocsInstaller.__installQtDoc">__installQtDoc</a></td> | |
| 96 <td>Private method to install/update a Qt help document.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#HelpDocsInstaller.installDocs">installDocs</a></td> | |
| 100 <td>Public method to start the installation procedure.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#HelpDocsInstaller.run">run</a></td> | |
| 104 <td>Public method executed by the thread.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#HelpDocsInstaller.stop">stop</a></td> | |
| 108 <td>Public slot to stop the installation procedure.</td> | |
| 109 </tr> | |
| 110 </table> | |
| 111 <h3>Static Methods</h3> | |
| 112 | |
| 113 <table> | |
| 114 <tr><td>None</td></tr> | |
| 115 </table> | |
| 116 | |
| 117 <a NAME="HelpDocsInstaller.__init__" ID="HelpDocsInstaller.__init__"></a> | |
| 118 <h4>HelpDocsInstaller (Constructor)</h4> | |
| 119 <b>HelpDocsInstaller</b>(<i>collection</i>) | |
| 120 | |
| 121 <p> | |
| 122 Constructor | |
| 123 </p> | |
| 124 <dl> | |
| 125 | |
| 126 <dt><i>collection</i></dt> | |
| 127 <dd> | |
| 128 full pathname of the collection file (string) | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="HelpDocsInstaller.__installEric7Doc" ID="HelpDocsInstaller.__installEric7Doc"></a> | |
| 132 <h4>HelpDocsInstaller.__installEric7Doc</h4> | |
| 133 <b>__installEric7Doc</b>(<i>engine</i>) | |
| 134 | |
| 135 <p> | |
| 136 Private method to install/update the eric help documentation. | |
| 137 </p> | |
| 138 <dl> | |
| 139 | |
| 140 <dt><i>engine</i></dt> | |
| 141 <dd> | |
| 142 reference to the help engine (QHelpEngineCore) | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <dl> | |
| 146 <dt>Return:</dt> | |
| 147 <dd> | |
| 148 flag indicating success (boolean) | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a> | |
| 152 <h4>HelpDocsInstaller.__installQtDoc</h4> | |
| 153 <b>__installQtDoc</b>(<i>name, version, engine</i>) | |
| 154 | |
| 155 <p> | |
| 156 Private method to install/update a Qt help document. | |
| 157 </p> | |
| 158 <dl> | |
| 159 | |
| 160 <dt><i>name</i></dt> | |
| 161 <dd> | |
| 162 name of the Qt help document (string) | |
| 163 </dd> | |
| 164 <dt><i>version</i></dt> | |
| 165 <dd> | |
| 166 Qt version of the help documens (integer) | |
| 167 </dd> | |
| 168 <dt><i>engine</i></dt> | |
| 169 <dd> | |
| 170 reference to the help engine (QHelpEngineCore) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <dl> | |
| 174 <dt>Return:</dt> | |
| 175 <dd> | |
| 176 flag indicating success (boolean) | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a> | |
| 180 <h4>HelpDocsInstaller.installDocs</h4> | |
| 181 <b>installDocs</b>(<i></i>) | |
| 182 | |
| 183 <p> | |
| 184 Public method to start the installation procedure. | |
| 185 </p> | |
| 186 <a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a> | |
| 187 <h4>HelpDocsInstaller.run</h4> | |
| 188 <b>run</b>(<i></i>) | |
| 189 | |
| 190 <p> | |
| 191 Public method executed by the thread. | |
| 192 </p> | |
| 193 <a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a> | |
| 194 <h4>HelpDocsInstaller.stop</h4> | |
| 195 <b>stop</b>(<i></i>) | |
| 196 | |
| 197 <p> | |
| 198 Public slot to stop the installation procedure. | |
| 199 </p> | |
| 200 <div align="right"><a href="#top">Up</a></div> | |
| 201 <hr /> | |
| 202 </body></html> |
