Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html
Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html
- changeset 4918
- 71caf42a13d8
- child 5038
- df7103c3f2a6
equal
deleted
inserted
replaced
| 4917:682750cc7bd5 | 4918:71caf42a13d8 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.QtHelp.HelpIndexWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.QtHelp.HelpIndexWidget</h1> | |
| 23 <p> | |
| 24 Module implementing a window for showing the QtHelp index. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#HelpIndexWidget">HelpIndexWidget</a></td> | |
| 34 <td>Class implementing a window for showing the QtHelp index.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a> | |
| 43 <h2>HelpIndexWidget</h2> | |
| 44 <p> | |
| 45 Class implementing a window for showing the QtHelp index. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>escapePressed()</dt> | |
| 49 <dd> | |
| 50 emitted when the ESC key was pressed | |
| 51 </dd><dt>linkActivated(QUrl)</dt> | |
| 52 <dd> | |
| 53 emitted when an index entry is activated | |
| 54 </dd><dt>linksActivated(links, keyword)</dt> | |
| 55 <dd> | |
| 56 emitted when an index entry | |
| 57 referencing multiple targets is activated | |
| 58 </dd> | |
| 59 </dl> | |
| 60 <h3>Derived from</h3> | |
| 61 QWidget | |
| 62 <h3>Class Attributes</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Class Methods</h3> | |
| 67 <table> | |
| 68 <tr><td>None</td></tr> | |
| 69 </table> | |
| 70 <h3>Methods</h3> | |
| 71 <table> | |
| 72 <tr> | |
| 73 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> | |
| 74 <td>Constructor</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#HelpIndexWidget.__activated">__activated</a></td> | |
| 77 <td>Private slot to handle the activation of a keyword entry.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> | |
| 80 <td>Private slot to enable the search edit.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> | |
| 83 <td>Private slot to enable the search edit.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> | |
| 86 <td>Private slot to filter the indices according to the given filter.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> | |
| 89 <td>Public method called to filter the event queue.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> | |
| 92 <td>Protected method handling focus in events.</td> | |
| 93 </tr> | |
| 94 </table> | |
| 95 <h3>Static Methods</h3> | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> | |
| 100 <h4>HelpIndexWidget (Constructor)</h4> | |
| 101 <b>HelpIndexWidget</b>(<i>engine, mainWindow, parent=None</i>) | |
| 102 <p> | |
| 103 Constructor | |
| 104 </p><dl> | |
| 105 <dt><i>engine</i></dt> | |
| 106 <dd> | |
| 107 reference to the help engine (QHelpEngine) | |
| 108 </dd><dt><i>mainWindow</i></dt> | |
| 109 <dd> | |
| 110 reference to the main window object (QMainWindow) | |
| 111 </dd><dt><i>parent</i></dt> | |
| 112 <dd> | |
| 113 reference to the parent widget (QWidget) | |
| 114 </dd> | |
| 115 </dl><a NAME="HelpIndexWidget.__activated" ID="HelpIndexWidget.__activated"></a> | |
| 116 <h4>HelpIndexWidget.__activated</h4> | |
| 117 <b>__activated</b>(<i>idx</i>) | |
| 118 <p> | |
| 119 Private slot to handle the activation of a keyword entry. | |
| 120 </p><dl> | |
| 121 <dt><i>idx</i></dt> | |
| 122 <dd> | |
| 123 index of the activated entry (QModelIndex) | |
| 124 </dd> | |
| 125 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> | |
| 126 <h4>HelpIndexWidget.__disableSearchEdit</h4> | |
| 127 <b>__disableSearchEdit</b>(<i></i>) | |
| 128 <p> | |
| 129 Private slot to enable the search edit. | |
| 130 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> | |
| 131 <h4>HelpIndexWidget.__enableSearchEdit</h4> | |
| 132 <b>__enableSearchEdit</b>(<i></i>) | |
| 133 <p> | |
| 134 Private slot to enable the search edit. | |
| 135 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> | |
| 136 <h4>HelpIndexWidget.__filterIndices</h4> | |
| 137 <b>__filterIndices</b>(<i>filter</i>) | |
| 138 <p> | |
| 139 Private slot to filter the indices according to the given filter. | |
| 140 </p><dl> | |
| 141 <dt><i>filter</i></dt> | |
| 142 <dd> | |
| 143 filter to be used (string) | |
| 144 </dd> | |
| 145 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> | |
| 146 <h4>HelpIndexWidget.eventFilter</h4> | |
| 147 <b>eventFilter</b>(<i>watched, event</i>) | |
| 148 <p> | |
| 149 Public method called to filter the event queue. | |
| 150 </p><dl> | |
| 151 <dt><i>watched</i></dt> | |
| 152 <dd> | |
| 153 the QObject being watched (QObject) | |
| 154 </dd><dt><i>event</i></dt> | |
| 155 <dd> | |
| 156 the event that occurred (QEvent) | |
| 157 </dd> | |
| 158 </dl><dl> | |
| 159 <dt>Returns:</dt> | |
| 160 <dd> | |
| 161 flag indicating whether the event was handled (boolean) | |
| 162 </dd> | |
| 163 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> | |
| 164 <h4>HelpIndexWidget.focusInEvent</h4> | |
| 165 <b>focusInEvent</b>(<i>evt</i>) | |
| 166 <p> | |
| 167 Protected method handling focus in events. | |
| 168 </p><dl> | |
| 169 <dt><i>evt</i></dt> | |
| 170 <dd> | |
| 171 reference to the focus event object (QFocusEvent) | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <div align="right"><a href="#top">Up</a></div> | |
| 175 <hr /> | |
| 176 </body></html> |
