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