Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpDocsInstaller.html

eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpDocsInstaller.html

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

Mercurial Repository: eric

eric ide

mercurial