Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpTopicDialog.html
src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpTopicDialog.html
- branch
- eric7
- changeset 9686
- 2eee7a645cba
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9685:b43e04854aba | 9686:2eee7a645cba |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QtHelpInterface.HelpTopicDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QtHelpInterface.HelpTopicDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to select a help topic to display. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#HelpTopicDialog">HelpTopicDialog</a></td> | |
| 25 <td>Class implementing a dialog to select a help topic to display.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="HelpTopicDialog" ID="HelpTopicDialog"></a> | |
| 36 <h2>HelpTopicDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to select a help topic to display. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_HelpTopicDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#HelpTopicDialog.__init__">HelpTopicDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#HelpTopicDialog.document">document</a></td> | |
| 63 <td>Public method to retrieve the selected help topic.</td> | |
| 64 </tr> | |
| 65 </table> | |
| 66 <h3>Static Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 | |
| 72 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a> | |
| 73 <h4>HelpTopicDialog (Constructor)</h4> | |
| 74 <b>HelpTopicDialog</b>(<i>parent, helpKeyword, documents</i>) | |
| 75 | |
| 76 <p> | |
| 77 Constructor | |
| 78 </p> | |
| 79 <dl> | |
| 80 | |
| 81 <dt><i>parent</i> (QWidget)</dt> | |
| 82 <dd> | |
| 83 reference to the parent widget | |
| 84 </dd> | |
| 85 <dt><i>helpKeyword</i> (str)</dt> | |
| 86 <dd> | |
| 87 keyword for the link set | |
| 88 </dd> | |
| 89 <dt><i>documents</i> (list of QHelpLink)</dt> | |
| 90 <dd> | |
| 91 list of help document link data structures | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <a NAME="HelpTopicDialog.document" ID="HelpTopicDialog.document"></a> | |
| 95 <h4>HelpTopicDialog.document</h4> | |
| 96 <b>document</b>(<i></i>) | |
| 97 | |
| 98 <p> | |
| 99 Public method to retrieve the selected help topic. | |
| 100 </p> | |
| 101 <dl> | |
| 102 <dt>Return:</dt> | |
| 103 <dd> | |
| 104 help document link for the selected help topic | |
| 105 </dd> | |
| 106 </dl> | |
| 107 <dl> | |
| 108 <dt>Return Type:</dt> | |
| 109 <dd> | |
| 110 QHelpLink | |
| 111 </dd> | |
| 112 </dl> | |
| 113 <div align="right"><a href="#top">Up</a></div> | |
| 114 <hr /> | |
| 115 </body></html> |
