Documentation/Source/eric5.Helpviewer.HelpTabWidget.html

changeset 653
0540f3c52b46
parent 638
265c31231d9d
child 767
27554f80d08f
equal deleted inserted replaced
651:e8020b9ac2b9 653:0540f3c52b46
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td> 57 <td><a href="#HelpTabWidget.__init__">HelpTabWidget</a></td>
58 <td>Constructor</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#HelpTabWidget.__currentChanged">__currentChanged</a></td>
61 <td>Private slot to handle an index change.</td>
62 </tr><tr>
60 <td><a href="#HelpTabWidget.__elide">__elide</a></td> 63 <td><a href="#HelpTabWidget.__elide">__elide</a></td>
61 <td>Private method to elide some text.</td> 64 <td>Private method to elide some text.</td>
62 </tr><tr> 65 </tr><tr>
66 <td><a href="#HelpTabWidget.__guessUrlFromPath">__guessUrlFromPath</a></td>
67 <td>Private method to guess an URL given a path string.</td>
68 </tr><tr>
63 <td><a href="#HelpTabWidget.__iconChanged">__iconChanged</a></td> 69 <td><a href="#HelpTabWidget.__iconChanged">__iconChanged</a></td>
64 <td>Private slot to handle the icon change.</td> 70 <td>Private slot to handle the icon change.</td>
65 </tr><tr> 71 </tr><tr>
66 <td><a href="#HelpTabWidget.__initTabContextMenu">__initTabContextMenu</a></td> 72 <td><a href="#HelpTabWidget.__initTabContextMenu">__initTabContextMenu</a></td>
67 <td>Private mezhod to create the tab context menu.</td> 73 <td>Private method to create the tab context menu.</td>
74 </tr><tr>
75 <td><a href="#HelpTabWidget.__lineEditReturnPressed">__lineEditReturnPressed</a></td>
76 <td>Private slot to handle the entering of an URL.</td>
68 </tr><tr> 77 </tr><tr>
69 <td><a href="#HelpTabWidget.__loadFinished">__loadFinished</a></td> 78 <td><a href="#HelpTabWidget.__loadFinished">__loadFinished</a></td>
70 <td>Private method to handle the loadFinished signal.</td> 79 <td>Private method to handle the loadFinished signal.</td>
71 </tr><tr> 80 </tr><tr>
72 <td><a href="#HelpTabWidget.__loadStarted">__loadStarted</a></td> 81 <td><a href="#HelpTabWidget.__loadStarted">__loadStarted</a></td>
73 <td>Private method to handle the loadStarted signal.</td> 82 <td>Private method to handle the loadStarted signal.</td>
74 </tr><tr> 83 </tr><tr>
75 <td><a href="#HelpTabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td> 84 <td><a href="#HelpTabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
76 <td>Private slot called to handle the navigation button menu selection.</td> 85 <td>Private slot called to handle the navigation button menu selection.</td>
77 </tr><tr> 86 </tr><tr>
87 <td><a href="#HelpTabWidget.__pathSelected">__pathSelected</a></td>
88 <td>Private slot called when a URL is selected from the completer.</td>
89 </tr><tr>
78 <td><a href="#HelpTabWidget.__printPdfRequested">__printPdfRequested</a></td> 90 <td><a href="#HelpTabWidget.__printPdfRequested">__printPdfRequested</a></td>
79 <td>Private slot to handle a print to PDF request.</td> 91 <td>Private slot to handle a print to PDF request.</td>
80 </tr><tr> 92 </tr><tr>
81 <td><a href="#HelpTabWidget.__printPreview">__printPreview</a></td> 93 <td><a href="#HelpTabWidget.__printPreview">__printPreview</a></td>
82 <td>Private slot to generate a print preview.</td> 94 <td>Private slot to generate a print preview.</td>
139 <td>Public slot to close a browser based on it's index.</td> 151 <td>Public slot to close a browser based on it's index.</td>
140 </tr><tr> 152 </tr><tr>
141 <td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td> 153 <td><a href="#HelpTabWidget.currentBrowser">currentBrowser</a></td>
142 <td>Public method to get a reference to the current browser.</td> 154 <td>Public method to get a reference to the current browser.</td>
143 </tr><tr> 155 </tr><tr>
156 <td><a href="#HelpTabWidget.currentUrlBar">currentUrlBar</a></td>
157 <td>Public method to get a reference to the current url bar.</td>
158 </tr><tr>
144 <td><a href="#HelpTabWidget.getSourceFileList">getSourceFileList</a></td> 159 <td><a href="#HelpTabWidget.getSourceFileList">getSourceFileList</a></td>
145 <td>Public method to get a list of all opened source files.</td> 160 <td>Public method to get a list of all opened source files.</td>
146 </tr><tr> 161 </tr><tr>
147 <td><a href="#HelpTabWidget.newBrowser">newBrowser</a></td> 162 <td><a href="#HelpTabWidget.newBrowser">newBrowser</a></td>
148 <td>Public method to create a new web browser tab.</td> 163 <td>Public method to create a new web browser tab.</td>
159 <td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td> 174 <td><a href="#HelpTabWidget.printPreviewBrowser">printPreviewBrowser</a></td>
160 <td>Public slot called to show a print preview of the displayed file.</td> 175 <td>Public slot called to show a print preview of the displayed file.</td>
161 </tr><tr> 176 </tr><tr>
162 <td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td> 177 <td><a href="#HelpTabWidget.shallShutDown">shallShutDown</a></td>
163 <td>Public method to check, if the application should be shut down.</td> 178 <td>Public method to check, if the application should be shut down.</td>
179 </tr><tr>
180 <td><a href="#HelpTabWidget.stackedUrlBar">stackedUrlBar</a></td>
181 <td>Public method to get a reference to the stacked url bar.</td>
164 </tr> 182 </tr>
165 </table> 183 </table>
166 <a NAME="HelpTabWidget.__init__" ID="HelpTabWidget.__init__"></a> 184 <a NAME="HelpTabWidget.__init__" ID="HelpTabWidget.__init__"></a>
167 <h4>HelpTabWidget (Constructor)</h4> 185 <h4>HelpTabWidget (Constructor)</h4>
168 <b>HelpTabWidget</b>(<i>parent</i>) 186 <b>HelpTabWidget</b>(<i>parent</i>)
171 </p><dl> 189 </p><dl>
172 <dt><i>parent</i></dt> 190 <dt><i>parent</i></dt>
173 <dd> 191 <dd>
174 reference to the parent widget (QWidget) 192 reference to the parent widget (QWidget)
175 </dd> 193 </dd>
194 </dl><a NAME="HelpTabWidget.__currentChanged" ID="HelpTabWidget.__currentChanged"></a>
195 <h4>HelpTabWidget.__currentChanged</h4>
196 <b>__currentChanged</b>(<i>index</i>)
197 <p>
198 Private slot to handle an index change.
199 </p><dl>
200 <dt><i>index</i></dt>
201 <dd>
202 new index (integer)
203 </dd>
176 </dl><a NAME="HelpTabWidget.__elide" ID="HelpTabWidget.__elide"></a> 204 </dl><a NAME="HelpTabWidget.__elide" ID="HelpTabWidget.__elide"></a>
177 <h4>HelpTabWidget.__elide</h4> 205 <h4>HelpTabWidget.__elide</h4>
178 <b>__elide</b>(<i>txt, mode = Qt.ElideRight, length = 40</i>) 206 <b>__elide</b>(<i>txt, mode = Qt.ElideRight, length = 40</i>)
179 <p> 207 <p>
180 Private method to elide some text. 208 Private method to elide some text.
191 </dd> 219 </dd>
192 </dl><dl> 220 </dl><dl>
193 <dt>Returns:</dt> 221 <dt>Returns:</dt>
194 <dd> 222 <dd>
195 the elided text (string) 223 the elided text (string)
224 </dd>
225 </dl><a NAME="HelpTabWidget.__guessUrlFromPath" ID="HelpTabWidget.__guessUrlFromPath"></a>
226 <h4>HelpTabWidget.__guessUrlFromPath</h4>
227 <b>__guessUrlFromPath</b>(<i>path</i>)
228 <p>
229 Private method to guess an URL given a path string.
230 </p><dl>
231 <dt><i>path</i></dt>
232 <dd>
233 path string to guess an URL for (string)
234 </dd>
235 </dl><dl>
236 <dt>Returns:</dt>
237 <dd>
238 guessed URL (QUrl)
196 </dd> 239 </dd>
197 </dl><a NAME="HelpTabWidget.__iconChanged" ID="HelpTabWidget.__iconChanged"></a> 240 </dl><a NAME="HelpTabWidget.__iconChanged" ID="HelpTabWidget.__iconChanged"></a>
198 <h4>HelpTabWidget.__iconChanged</h4> 241 <h4>HelpTabWidget.__iconChanged</h4>
199 <b>__iconChanged</b>(<i></i>) 242 <b>__iconChanged</b>(<i></i>)
200 <p> 243 <p>
201 Private slot to handle the icon change. 244 Private slot to handle the icon change.
202 </p><a NAME="HelpTabWidget.__initTabContextMenu" ID="HelpTabWidget.__initTabContextMenu"></a> 245 </p><a NAME="HelpTabWidget.__initTabContextMenu" ID="HelpTabWidget.__initTabContextMenu"></a>
203 <h4>HelpTabWidget.__initTabContextMenu</h4> 246 <h4>HelpTabWidget.__initTabContextMenu</h4>
204 <b>__initTabContextMenu</b>(<i></i>) 247 <b>__initTabContextMenu</b>(<i></i>)
205 <p> 248 <p>
206 Private mezhod to create the tab context menu. 249 Private method to create the tab context menu.
250 </p><a NAME="HelpTabWidget.__lineEditReturnPressed" ID="HelpTabWidget.__lineEditReturnPressed"></a>
251 <h4>HelpTabWidget.__lineEditReturnPressed</h4>
252 <b>__lineEditReturnPressed</b>(<i></i>)
253 <p>
254 Private slot to handle the entering of an URL.
207 </p><a NAME="HelpTabWidget.__loadFinished" ID="HelpTabWidget.__loadFinished"></a> 255 </p><a NAME="HelpTabWidget.__loadFinished" ID="HelpTabWidget.__loadFinished"></a>
208 <h4>HelpTabWidget.__loadFinished</h4> 256 <h4>HelpTabWidget.__loadFinished</h4>
209 <b>__loadFinished</b>(<i>ok</i>) 257 <b>__loadFinished</b>(<i>ok</i>)
210 <p> 258 <p>
211 Private method to handle the loadFinished signal. 259 Private method to handle the loadFinished signal.
227 </p><dl> 275 </p><dl>
228 <dt><i>act</i></dt> 276 <dt><i>act</i></dt>
229 <dd> 277 <dd>
230 reference to the selected action (QAction) 278 reference to the selected action (QAction)
231 </dd> 279 </dd>
280 </dl><a NAME="HelpTabWidget.__pathSelected" ID="HelpTabWidget.__pathSelected"></a>
281 <h4>HelpTabWidget.__pathSelected</h4>
282 <b>__pathSelected</b>(<i>path</i>)
283 <p>
284 Private slot called when a URL is selected from the completer.
285 </p><dl>
286 <dt><i>path</i></dt>
287 <dd>
288 path to be shown (string)
289 </dd>
232 </dl><a NAME="HelpTabWidget.__printPdfRequested" ID="HelpTabWidget.__printPdfRequested"></a> 290 </dl><a NAME="HelpTabWidget.__printPdfRequested" ID="HelpTabWidget.__printPdfRequested"></a>
233 <h4>HelpTabWidget.__printPdfRequested</h4> 291 <h4>HelpTabWidget.__printPdfRequested</h4>
234 <b>__printPdfRequested</b>(<i>frame</i>) 292 <b>__printPdfRequested</b>(<i>frame</i>)
235 <p> 293 <p>
236 Private slot to handle a print to PDF request. 294 Private slot to handle a print to PDF request.
395 </p><dl> 453 </p><dl>
396 <dt>Returns:</dt> 454 <dt>Returns:</dt>
397 <dd> 455 <dd>
398 reference to the current browser (HelpBrowser) 456 reference to the current browser (HelpBrowser)
399 </dd> 457 </dd>
458 </dl><a NAME="HelpTabWidget.currentUrlBar" ID="HelpTabWidget.currentUrlBar"></a>
459 <h4>HelpTabWidget.currentUrlBar</h4>
460 <b>currentUrlBar</b>(<i></i>)
461 <p>
462 Public method to get a reference to the current url bar.
463 </p><dl>
464 <dt>Returns:</dt>
465 <dd>
466 reference to the current url bar (UrlBar)
467 </dd>
400 </dl><a NAME="HelpTabWidget.getSourceFileList" ID="HelpTabWidget.getSourceFileList"></a> 468 </dl><a NAME="HelpTabWidget.getSourceFileList" ID="HelpTabWidget.getSourceFileList"></a>
401 <h4>HelpTabWidget.getSourceFileList</h4> 469 <h4>HelpTabWidget.getSourceFileList</h4>
402 <b>getSourceFileList</b>(<i></i>) 470 <b>getSourceFileList</b>(<i></i>)
403 <p> 471 <p>
404 Public method to get a list of all opened source files. 472 Public method to get a list of all opened source files.
460 </p><dl> 528 </p><dl>
461 <dt>Returns:</dt> 529 <dt>Returns:</dt>
462 <dd> 530 <dd>
463 flag indicating a shut down (boolean) 531 flag indicating a shut down (boolean)
464 </dd> 532 </dd>
533 </dl><a NAME="HelpTabWidget.stackedUrlBar" ID="HelpTabWidget.stackedUrlBar"></a>
534 <h4>HelpTabWidget.stackedUrlBar</h4>
535 <b>stackedUrlBar</b>(<i></i>)
536 <p>
537 Public method to get a reference to the stacked url bar.
538 </p><dl>
539 <dt>Returns:</dt>
540 <dd>
541 reference to the stacked url bar (StackedUrlBar)
542 </dd>
465 </dl> 543 </dl>
466 <div align="right"><a href="#top">Up</a></div> 544 <div align="right"><a href="#top">Up</a></div>
467 <hr /> 545 <hr />
468 </body></html> 546 </body></html>

eric ide

mercurial