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 10479
- 856476537696
- parent 9686
- 2eee7a645cba
- child 11227
- 023943c77c42
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.QtHelpInterface.HelpDocsInstaller</h1> | 9 <h1>eric7.QtHelpInterface.HelpDocsInstaller</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a thread class populating and updating the QtHelp | 11 Module implementing a thread class populating and updating the QtHelp |
| 13 documentation database. | 12 documentation database. |
| 14 </p> | 13 </p> |
| 14 | |
| 15 <h3>Global Attributes</h3> | 15 <h3>Global Attributes</h3> |
| 16 | |
| 17 <table> | 16 <table> |
| 18 <tr><td>None</td></tr> | 17 <tr><td>None</td></tr> |
| 19 </table> | 18 </table> |
| 19 | |
| 20 <h3>Classes</h3> | 20 <h3>Classes</h3> |
| 21 | |
| 22 <table> | 21 <table> |
| 23 | |
| 24 <tr> | 22 <tr> |
| 25 <td><a href="#HelpDocsInstaller">HelpDocsInstaller</a></td> | 23 <td><a href="#HelpDocsInstaller">HelpDocsInstaller</a></td> |
| 26 <td>Class implementing the worker thread populating and updating the QtHelp documentation database.</td> | 24 <td>Class implementing the worker thread populating and updating the QtHelp documentation database.</td> |
| 27 </tr> | 25 </tr> |
| 28 </table> | 26 </table> |
| 27 | |
| 29 <h3>Functions</h3> | 28 <h3>Functions</h3> |
| 30 | |
| 31 <table> | 29 <table> |
| 32 <tr><td>None</td></tr> | 30 <tr><td>None</td></tr> |
| 33 </table> | 31 </table> |
| 32 | |
| 34 <hr /> | 33 <hr /> |
| 35 <hr /> | 34 <hr /> |
| 36 <a NAME="HelpDocsInstaller" ID="HelpDocsInstaller"></a> | 35 <a NAME="HelpDocsInstaller" ID="HelpDocsInstaller"></a> |
| 37 <h2>HelpDocsInstaller</h2> | 36 <h2>HelpDocsInstaller</h2> |
| 38 | |
| 39 <p> | 37 <p> |
| 40 Class implementing the worker thread populating and updating the QtHelp | 38 Class implementing the worker thread populating and updating the QtHelp |
| 41 documentation database. | 39 documentation database. |
| 42 </p> | 40 </p> |
| 41 | |
| 43 <h3>Signals</h3> | 42 <h3>Signals</h3> |
| 44 <dl> | 43 <dl> |
| 45 | 44 |
| 46 <dt>docsInstalled(bool)</dt> | 45 <dt>docsInstalled(bool)</dt> |
| 47 <dd> | 46 <dd> |
| 54 </dd> | 53 </dd> |
| 55 </dl> | 54 </dl> |
| 56 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 57 QThread | 56 QThread |
| 58 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 59 | |
| 60 <table> | 58 <table> |
| 61 <tr><td>None</td></tr> | 59 <tr><td>None</td></tr> |
| 62 </table> | 60 </table> |
| 61 | |
| 63 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 64 | |
| 65 <table> | 63 <table> |
| 66 <tr><td>None</td></tr> | 64 <tr><td>None</td></tr> |
| 67 </table> | 65 </table> |
| 66 | |
| 68 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 69 | |
| 70 <table> | 68 <table> |
| 71 | |
| 72 <tr> | 69 <tr> |
| 73 <td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td> | 70 <td><a href="#HelpDocsInstaller.__init__">HelpDocsInstaller</a></td> |
| 74 <td>Constructor</td> | 71 <td>Constructor</td> |
| 75 </tr> | 72 </tr> |
| 76 <tr> | 73 <tr> |
| 92 <tr> | 89 <tr> |
| 93 <td><a href="#HelpDocsInstaller.stop">stop</a></td> | 90 <td><a href="#HelpDocsInstaller.stop">stop</a></td> |
| 94 <td>Public slot to stop the installation procedure.</td> | 91 <td>Public slot to stop the installation procedure.</td> |
| 95 </tr> | 92 </tr> |
| 96 </table> | 93 </table> |
| 94 | |
| 97 <h3>Static Methods</h3> | 95 <h3>Static Methods</h3> |
| 98 | |
| 99 <table> | 96 <table> |
| 100 <tr><td>None</td></tr> | 97 <tr><td>None</td></tr> |
| 101 </table> | 98 </table> |
| 102 | 99 |
| 100 | |
| 103 <a NAME="HelpDocsInstaller.__init__" ID="HelpDocsInstaller.__init__"></a> | 101 <a NAME="HelpDocsInstaller.__init__" ID="HelpDocsInstaller.__init__"></a> |
| 104 <h4>HelpDocsInstaller (Constructor)</h4> | 102 <h4>HelpDocsInstaller (Constructor)</h4> |
| 105 <b>HelpDocsInstaller</b>(<i>collection</i>) | 103 <b>HelpDocsInstaller</b>(<i>collection</i>) |
| 106 | |
| 107 <p> | 104 <p> |
| 108 Constructor | 105 Constructor |
| 109 </p> | 106 </p> |
| 107 | |
| 110 <dl> | 108 <dl> |
| 111 | 109 |
| 112 <dt><i>collection</i> (str)</dt> | 110 <dt><i>collection</i> (str)</dt> |
| 113 <dd> | 111 <dd> |
| 114 full pathname of the collection file | 112 full pathname of the collection file |
| 115 </dd> | 113 </dd> |
| 116 </dl> | 114 </dl> |
| 117 <a NAME="HelpDocsInstaller.__installEric7Doc" ID="HelpDocsInstaller.__installEric7Doc"></a> | 115 <a NAME="HelpDocsInstaller.__installEric7Doc" ID="HelpDocsInstaller.__installEric7Doc"></a> |
| 118 <h4>HelpDocsInstaller.__installEric7Doc</h4> | 116 <h4>HelpDocsInstaller.__installEric7Doc</h4> |
| 119 <b>__installEric7Doc</b>(<i>engine</i>) | 117 <b>__installEric7Doc</b>(<i>engine</i>) |
| 120 | |
| 121 <p> | 118 <p> |
| 122 Private method to install/update the eric help documentation. | 119 Private method to install/update the eric help documentation. |
| 123 </p> | 120 </p> |
| 121 | |
| 124 <dl> | 122 <dl> |
| 125 | 123 |
| 126 <dt><i>engine</i> (QHelpEngineCore)</dt> | 124 <dt><i>engine</i> (QHelpEngineCore)</dt> |
| 127 <dd> | 125 <dd> |
| 128 reference to the help engine | 126 reference to the help engine |
| 141 </dd> | 139 </dd> |
| 142 </dl> | 140 </dl> |
| 143 <a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a> | 141 <a NAME="HelpDocsInstaller.__installQtDoc" ID="HelpDocsInstaller.__installQtDoc"></a> |
| 144 <h4>HelpDocsInstaller.__installQtDoc</h4> | 142 <h4>HelpDocsInstaller.__installQtDoc</h4> |
| 145 <b>__installQtDoc</b>(<i>name, version, engine</i>) | 143 <b>__installQtDoc</b>(<i>name, version, engine</i>) |
| 146 | |
| 147 <p> | 144 <p> |
| 148 Private method to install/update a Qt help document. | 145 Private method to install/update a Qt help document. |
| 149 </p> | 146 </p> |
| 147 | |
| 150 <dl> | 148 <dl> |
| 151 | 149 |
| 152 <dt><i>name</i> (str)</dt> | 150 <dt><i>name</i> (str)</dt> |
| 153 <dd> | 151 <dd> |
| 154 name of the Qt help document | 152 name of the Qt help document |
| 175 </dd> | 173 </dd> |
| 176 </dl> | 174 </dl> |
| 177 <a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a> | 175 <a NAME="HelpDocsInstaller.installDocs" ID="HelpDocsInstaller.installDocs"></a> |
| 178 <h4>HelpDocsInstaller.installDocs</h4> | 176 <h4>HelpDocsInstaller.installDocs</h4> |
| 179 <b>installDocs</b>(<i></i>) | 177 <b>installDocs</b>(<i></i>) |
| 180 | |
| 181 <p> | 178 <p> |
| 182 Public method to start the installation procedure. | 179 Public method to start the installation procedure. |
| 183 </p> | 180 </p> |
| 181 | |
| 184 <a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a> | 182 <a NAME="HelpDocsInstaller.run" ID="HelpDocsInstaller.run"></a> |
| 185 <h4>HelpDocsInstaller.run</h4> | 183 <h4>HelpDocsInstaller.run</h4> |
| 186 <b>run</b>(<i></i>) | 184 <b>run</b>(<i></i>) |
| 187 | |
| 188 <p> | 185 <p> |
| 189 Public method executed by the thread. | 186 Public method executed by the thread. |
| 190 </p> | 187 </p> |
| 188 | |
| 191 <a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a> | 189 <a NAME="HelpDocsInstaller.stop" ID="HelpDocsInstaller.stop"></a> |
| 192 <h4>HelpDocsInstaller.stop</h4> | 190 <h4>HelpDocsInstaller.stop</h4> |
| 193 <b>stop</b>(<i></i>) | 191 <b>stop</b>(<i></i>) |
| 194 | |
| 195 <p> | 192 <p> |
| 196 Public slot to stop the installation procedure. | 193 Public slot to stop the installation procedure. |
| 197 </p> | 194 </p> |
| 195 | |
| 198 <div align="right"><a href="#top">Up</a></div> | 196 <div align="right"><a href="#top">Up</a></div> |
| 199 <hr /> | 197 <hr /> |
| 200 </body></html> | 198 </body></html> |
