Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.UI.CodeDocumentationViewer.html

Documentation/Source/eric6.UI.CodeDocumentationViewer.html

changeset 6506
ff6172ce89a9
parent 6505
470d878cbe9f
equal deleted inserted replaced
6505:470d878cbe9f 6506:ff6172ce89a9
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#CodeDocumentationViewer">CodeDocumentationViewer</a></td> 34 <td><a href="#CodeDocumentationViewer">CodeDocumentationViewer</a></td>
35 <td>Class implementing a widget to show some source code information provided by plug-ins.</td> 35 <td>Class implementing a widget to show some source code information provided by plug-ins.</td>
36 </tr><tr> 36 </tr><tr>
37 <td><a href="#PlainTextDocumentationViewer">PlainTextDocumentationViewer</a></td> 37 <td><a href="#DocumentationViewerWidget">DocumentationViewerWidget</a></td>
38 <td>Class implementing the plain text documentation viewer.</td> 38 <td>Class implementing a rich text documentation viewer.</td>
39 </tr><tr>
40 <td><a href="#WebViewDocumentationViewer">WebViewDocumentationViewer</a></td>
41 <td>Class implementing the rich text documentation viewer.</td>
42 </tr> 39 </tr>
43 </table> 40 </table>
44 <h3>Functions</h3> 41 <h3>Functions</h3>
45 <table> 42 <table>
46 <tr><td>None</td></tr> 43 <tr><td>None</td></tr>
79 <td>Constructor</td> 76 <td>Constructor</td>
80 </tr><tr> 77 </tr><tr>
81 <td><a href="#CodeDocumentationViewer.__selectProvider">__selectProvider</a></td> 78 <td><a href="#CodeDocumentationViewer.__selectProvider">__selectProvider</a></td>
82 <td>Private method to select a provider programmatically.</td> 79 <td>Private method to select a provider programmatically.</td>
83 </tr><tr> 80 </tr><tr>
84 <td><a href="#CodeDocumentationViewer.__setHtml">__setHtml</a></td>
85 <td>Private slot to set the prepared HTML text.</td>
86 </tr><tr>
87 <td><a href="#CodeDocumentationViewer.__setupUi">__setupUi</a></td> 81 <td><a href="#CodeDocumentationViewer.__setupUi">__setupUi</a></td>
88 <td>Private method to generate the UI layout.</td> 82 <td>Private method to generate the UI layout.</td>
89 </tr><tr> 83 </tr><tr>
90 <td><a href="#CodeDocumentationViewer.__showDisabledMessage">__showDisabledMessage</a></td> 84 <td><a href="#CodeDocumentationViewer.__showDisabledMessage">__showDisabledMessage</a></td>
91 <td>Private method to show a message giving the reason for being disabled.</td> 85 <td>Private method to show a message giving the reason for being disabled.</td>
145 Private method to select a provider programmatically. 139 Private method to select a provider programmatically.
146 </p><dl> 140 </p><dl>
147 <dt><i>provider</i> (str)</dt> 141 <dt><i>provider</i> (str)</dt>
148 <dd> 142 <dd>
149 name of the provider to be selected 143 name of the provider to be selected
150 </dd>
151 </dl><a NAME="CodeDocumentationViewer.__setHtml" ID="CodeDocumentationViewer.__setHtml"></a>
152 <h4>CodeDocumentationViewer.__setHtml</h4>
153 <b>__setHtml</b>(<i>html</i>)
154 <p>
155 Private slot to set the prepared HTML text.
156 </p><dl>
157 <dt><i>html</i> (str)</dt>
158 <dd>
159 prepared HTML text
160 </dd> 144 </dd>
161 </dl><a NAME="CodeDocumentationViewer.__setupUi" ID="CodeDocumentationViewer.__setupUi"></a> 145 </dl><a NAME="CodeDocumentationViewer.__setupUi" ID="CodeDocumentationViewer.__setupUi"></a>
162 <h4>CodeDocumentationViewer.__setupUi</h4> 146 <h4>CodeDocumentationViewer.__setupUi</h4>
163 <b>__setupUi</b>(<i></i>) 147 <b>__setupUi</b>(<i></i>)
164 <p> 148 <p>
307 name of the provider (must be unique) 291 name of the provider (must be unique)
308 </dd> 292 </dd>
309 </dl> 293 </dl>
310 <div align="right"><a href="#top">Up</a></div> 294 <div align="right"><a href="#top">Up</a></div>
311 <hr /><hr /> 295 <hr /><hr />
312 <a NAME="PlainTextDocumentationViewer" ID="PlainTextDocumentationViewer"></a> 296 <a NAME="DocumentationViewerWidget" ID="DocumentationViewerWidget"></a>
313 <h2>PlainTextDocumentationViewer</h2> 297 <h2>DocumentationViewerWidget</h2>
314 <p> 298 <p>
315 Class implementing the plain text documentation viewer. 299 Class implementing a rich text documentation viewer.
316 </p> 300 </p>
317 <h3>Derived from</h3> 301 <h3>Derived from</h3>
318 QWidget 302 QWidget
319 <h3>Class Attributes</h3> 303 <h3>Class Attributes</h3>
320 <table> 304 <table>
325 <tr><td>None</td></tr> 309 <tr><td>None</td></tr>
326 </table> 310 </table>
327 <h3>Methods</h3> 311 <h3>Methods</h3>
328 <table> 312 <table>
329 <tr> 313 <tr>
330 <td><a href="#PlainTextDocumentationViewer.__init__">PlainTextDocumentationViewer</a></td> 314 <td><a href="#DocumentationViewerWidget.__init__">DocumentationViewerWidget</a></td>
331 <td>Constructor</td> 315 <td>Constructor</td>
332 </tr><tr> 316 </tr><tr>
333 <td><a href="#PlainTextDocumentationViewer.clear">clear</a></td> 317 <td><a href="#DocumentationViewerWidget.__showLink">__showLink</a></td>
334 <td>Public method to clear the contents.</td>
335 </tr><tr>
336 <td><a href="#PlainTextDocumentationViewer.preferencesChanged">preferencesChanged</a></td>
337 <td>Public slot to handle a change of preferences.</td>
338 </tr><tr>
339 <td><a href="#PlainTextDocumentationViewer.setText">setText</a></td>
340 <td>Public method to set the text to be shown.</td>
341 </tr>
342 </table>
343 <h3>Static Methods</h3>
344 <table>
345 <tr><td>None</td></tr>
346 </table>
347 <a NAME="PlainTextDocumentationViewer.__init__" ID="PlainTextDocumentationViewer.__init__"></a>
348 <h4>PlainTextDocumentationViewer (Constructor)</h4>
349 <b>PlainTextDocumentationViewer</b>(<i>parent=None</i>)
350 <p>
351 Constructor
352 </p><dl>
353 <dt><i>parent</i> (QWidget)</dt>
354 <dd>
355 reference to the parent widget
356 </dd>
357 </dl><a NAME="PlainTextDocumentationViewer.clear" ID="PlainTextDocumentationViewer.clear"></a>
358 <h4>PlainTextDocumentationViewer.clear</h4>
359 <b>clear</b>(<i></i>)
360 <p>
361 Public method to clear the contents.
362 </p><a NAME="PlainTextDocumentationViewer.preferencesChanged" ID="PlainTextDocumentationViewer.preferencesChanged"></a>
363 <h4>PlainTextDocumentationViewer.preferencesChanged</h4>
364 <b>preferencesChanged</b>(<i></i>)
365 <p>
366 Public slot to handle a change of preferences.
367 </p><a NAME="PlainTextDocumentationViewer.setText" ID="PlainTextDocumentationViewer.setText"></a>
368 <h4>PlainTextDocumentationViewer.setText</h4>
369 <b>setText</b>(<i>text</i>)
370 <p>
371 Public method to set the text to be shown.
372 </p><dl>
373 <dt><i>text</i> (str)</dt>
374 <dd>
375 text to be shown
376 </dd>
377 </dl>
378 <div align="right"><a href="#top">Up</a></div>
379 <hr /><hr />
380 <a NAME="WebViewDocumentationViewer" ID="WebViewDocumentationViewer"></a>
381 <h2>WebViewDocumentationViewer</h2>
382 <p>
383 Class implementing the rich text documentation viewer.
384 </p>
385 <h3>Derived from</h3>
386 QWidget
387 <h3>Class Attributes</h3>
388 <table>
389 <tr><td>None</td></tr>
390 </table>
391 <h3>Class Methods</h3>
392 <table>
393 <tr><td>None</td></tr>
394 </table>
395 <h3>Methods</h3>
396 <table>
397 <tr>
398 <td><a href="#WebViewDocumentationViewer.__init__">WebViewDocumentationViewer</a></td>
399 <td>Constructor</td>
400 </tr><tr>
401 <td><a href="#WebViewDocumentationViewer.__showLink">__showLink</a></td>
402 <td>Private slot to show the hovered link in a tooltip.</td> 318 <td>Private slot to show the hovered link in a tooltip.</td>
403 </tr><tr> 319 </tr><tr>
404 <td><a href="#WebViewDocumentationViewer.clear">clear</a></td> 320 <td><a href="#DocumentationViewerWidget.clear">clear</a></td>
405 <td>Public method to clear the shown contents.</td> 321 <td>Public method to clear the shown contents.</td>
406 </tr><tr> 322 </tr><tr>
407 <td><a href="#WebViewDocumentationViewer.setHtml">setHtml</a></td> 323 <td><a href="#DocumentationViewerWidget.setHtml">setHtml</a></td>
408 <td>Public method to set the HTML text of the widget.</td> 324 <td>Public method to set the HTML text of the widget.</td>
409 </tr> 325 </tr>
410 </table> 326 </table>
411 <h3>Static Methods</h3> 327 <h3>Static Methods</h3>
412 <table> 328 <table>
413 <tr><td>None</td></tr> 329 <tr><td>None</td></tr>
414 </table> 330 </table>
415 <a NAME="WebViewDocumentationViewer.__init__" ID="WebViewDocumentationViewer.__init__"></a> 331 <a NAME="DocumentationViewerWidget.__init__" ID="DocumentationViewerWidget.__init__"></a>
416 <h4>WebViewDocumentationViewer (Constructor)</h4> 332 <h4>DocumentationViewerWidget (Constructor)</h4>
417 <b>WebViewDocumentationViewer</b>(<i>parent=None</i>) 333 <b>DocumentationViewerWidget</b>(<i>parent=None</i>)
418 <p> 334 <p>
419 Constructor 335 Constructor
420 </p><dl> 336 </p><dl>
421 <dt><i>parent</i> (QWidget)</dt> 337 <dt><i>parent</i> (QWidget)</dt>
422 <dd> 338 <dd>
423 reference to the parent widget 339 reference to the parent widget
424 </dd> 340 </dd>
425 </dl><a NAME="WebViewDocumentationViewer.__showLink" ID="WebViewDocumentationViewer.__showLink"></a> 341 </dl><a NAME="DocumentationViewerWidget.__showLink" ID="DocumentationViewerWidget.__showLink"></a>
426 <h4>WebViewDocumentationViewer.__showLink</h4> 342 <h4>DocumentationViewerWidget.__showLink</h4>
427 <b>__showLink</b>(<i>urlStr</i>) 343 <b>__showLink</b>(<i>urlStr</i>)
428 <p> 344 <p>
429 Private slot to show the hovered link in a tooltip. 345 Private slot to show the hovered link in a tooltip.
430 </p><dl> 346 </p><dl>
431 <dt><i>urlStr</i> (str)</dt> 347 <dt><i>urlStr</i> (str)</dt>
432 <dd> 348 <dd>
433 hovered URL 349 hovered URL
434 </dd> 350 </dd>
435 </dl><a NAME="WebViewDocumentationViewer.clear" ID="WebViewDocumentationViewer.clear"></a> 351 </dl><a NAME="DocumentationViewerWidget.clear" ID="DocumentationViewerWidget.clear"></a>
436 <h4>WebViewDocumentationViewer.clear</h4> 352 <h4>DocumentationViewerWidget.clear</h4>
437 <b>clear</b>(<i></i>) 353 <b>clear</b>(<i></i>)
438 <p> 354 <p>
439 Public method to clear the shown contents. 355 Public method to clear the shown contents.
440 </p><a NAME="WebViewDocumentationViewer.setHtml" ID="WebViewDocumentationViewer.setHtml"></a> 356 </p><a NAME="DocumentationViewerWidget.setHtml" ID="DocumentationViewerWidget.setHtml"></a>
441 <h4>WebViewDocumentationViewer.setHtml</h4> 357 <h4>DocumentationViewerWidget.setHtml</h4>
442 <b>setHtml</b>(<i>html</i>) 358 <b>setHtml</b>(<i>html</i>)
443 <p> 359 <p>
444 Public method to set the HTML text of the widget. 360 Public method to set the HTML text of the widget.
445 </p><dl> 361 </p><dl>
446 <dt><i>html</i> (str)</dt> 362 <dt><i>html</i> (str)</dt>

Mercurial Repository: eric

eric ide

mercurial