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