Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpIndexWidget.html
src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpIndexWidget.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.HelpIndexWidget</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.HelpIndexWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a window for showing the QtHelp index. | |
| 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="#HelpIndexWidget">HelpIndexWidget</a></td> | |
| 25 <td>Class implementing a window for showing the QtHelp index.</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="HelpIndexWidget" ID="HelpIndexWidget"></a> | |
| 36 <h2>HelpIndexWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a window for showing the QtHelp index. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>escapePressed()</dt> | |
| 45 <dd> | |
| 46 emitted when the ESC key was pressed | |
| 47 </dd> | |
| 48 <dt>newBackgroundTab(QUrl, str)</dt> | |
| 49 <dd> | |
| 50 emitted to open an entry in a | |
| 51 new background tab | |
| 52 </dd> | |
| 53 <dt>newTab(QUrl, str)</dt> | |
| 54 <dd> | |
| 55 emitted to open an entry in a new tab | |
| 56 </dd> | |
| 57 <dt>newWindow(QUrl, str)</dt> | |
| 58 <dd> | |
| 59 emitted to open an entry in a new window | |
| 60 </dd> | |
| 61 <dt>openUrl(QUrl, str)</dt> | |
| 62 <dd> | |
| 63 emitted to open an entry in the current tab | |
| 64 </dd> | |
| 65 </dl> | |
| 66 <h3>Derived from</h3> | |
| 67 QWidget | |
| 68 <h3>Class Attributes</h3> | |
| 69 | |
| 70 <table> | |
| 71 <tr><td>None</td></tr> | |
| 72 </table> | |
| 73 <h3>Class Methods</h3> | |
| 74 | |
| 75 <table> | |
| 76 <tr><td>None</td></tr> | |
| 77 </table> | |
| 78 <h3>Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 | |
| 82 <tr> | |
| 83 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> | |
| 84 <td>Constructor</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> | |
| 88 <td>Private slot to enable the search edit.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#HelpIndexWidget.__documentActivated">__documentActivated</a></td> | |
| 92 <td>Private slot to handle the activation of a keyword entry.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#HelpIndexWidget.__documentsActivated">__documentsActivated</a></td> | |
| 96 <td>Private slot to handle the activation of an entry with multiple help documents.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> | |
| 100 <td>Private slot to enable the search edit.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> | |
| 104 <td>Private slot to filter the indexes according to the given filter.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#HelpIndexWidget.__selectDocument">__selectDocument</a></td> | |
| 108 <td>Private method to give the user a chance to select among the given documents.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> | |
| 112 <td>Private slot showing the context menu.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> | |
| 116 <td>Public method called to filter the event queue.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> | |
| 120 <td>Protected method handling focus in events.</td> | |
| 121 </tr> | |
| 122 </table> | |
| 123 <h3>Static Methods</h3> | |
| 124 | |
| 125 <table> | |
| 126 <tr><td>None</td></tr> | |
| 127 </table> | |
| 128 | |
| 129 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> | |
| 130 <h4>HelpIndexWidget (Constructor)</h4> | |
| 131 <b>HelpIndexWidget</b>(<i>engine, internal=False, parent=None</i>) | |
| 132 | |
| 133 <p> | |
| 134 Constructor | |
| 135 </p> | |
| 136 <dl> | |
| 137 | |
| 138 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 139 <dd> | |
| 140 reference to the help engine | |
| 141 </dd> | |
| 142 <dt><i>internal</i> (bool)</dt> | |
| 143 <dd> | |
| 144 flag indicating the internal help viewer | |
| 145 </dd> | |
| 146 <dt><i>parent</i> (QWidget)</dt> | |
| 147 <dd> | |
| 148 reference to the parent widget | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> | |
| 152 <h4>HelpIndexWidget.__disableSearchEdit</h4> | |
| 153 <b>__disableSearchEdit</b>(<i></i>) | |
| 154 | |
| 155 <p> | |
| 156 Private slot to enable the search edit. | |
| 157 </p> | |
| 158 <a NAME="HelpIndexWidget.__documentActivated" ID="HelpIndexWidget.__documentActivated"></a> | |
| 159 <h4>HelpIndexWidget.__documentActivated</h4> | |
| 160 <b>__documentActivated</b>(<i>document, keyword, modifiers=None</i>) | |
| 161 | |
| 162 <p> | |
| 163 Private slot to handle the activation of a keyword entry. | |
| 164 </p> | |
| 165 <dl> | |
| 166 | |
| 167 <dt><i>document</i> (QHelpLink)</dt> | |
| 168 <dd> | |
| 169 reference to a data structure containing the | |
| 170 document info | |
| 171 </dd> | |
| 172 <dt><i>keyword</i> (str)</dt> | |
| 173 <dd> | |
| 174 keyword for the URL | |
| 175 </dd> | |
| 176 <dt><i>modifiers</i> (Qt.KeyboardModifiers or None)</dt> | |
| 177 <dd> | |
| 178 keyboard modifiers | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <a NAME="HelpIndexWidget.__documentsActivated" ID="HelpIndexWidget.__documentsActivated"></a> | |
| 182 <h4>HelpIndexWidget.__documentsActivated</h4> | |
| 183 <b>__documentsActivated</b>(<i>documents, helpKeyword</i>) | |
| 184 | |
| 185 <p> | |
| 186 Private slot to handle the activation of an entry with multiple help | |
| 187 documents. | |
| 188 </p> | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>documents</i> (list of QHelpLink)</dt> | |
| 192 <dd> | |
| 193 list of help document link data structures | |
| 194 </dd> | |
| 195 <dt><i>helpKeyword</i> (str)</dt> | |
| 196 <dd> | |
| 197 keyword for the entry | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> | |
| 201 <h4>HelpIndexWidget.__enableSearchEdit</h4> | |
| 202 <b>__enableSearchEdit</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Private slot to enable the search edit. | |
| 206 </p> | |
| 207 <a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> | |
| 208 <h4>HelpIndexWidget.__filterIndices</h4> | |
| 209 <b>__filterIndices</b>(<i>indexFilter</i>) | |
| 210 | |
| 211 <p> | |
| 212 Private slot to filter the indexes according to the given filter. | |
| 213 </p> | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>indexFilter</i> (str)</dt> | |
| 217 <dd> | |
| 218 filter to be used | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <a NAME="HelpIndexWidget.__selectDocument" ID="HelpIndexWidget.__selectDocument"></a> | |
| 222 <h4>HelpIndexWidget.__selectDocument</h4> | |
| 223 <b>__selectDocument</b>(<i>documents, helpKeyword</i>) | |
| 224 | |
| 225 <p> | |
| 226 Private method to give the user a chance to select among the | |
| 227 given documents. | |
| 228 </p> | |
| 229 <dl> | |
| 230 | |
| 231 <dt><i>documents</i> (list of QHelpLink)</dt> | |
| 232 <dd> | |
| 233 list of help document link data structures | |
| 234 </dd> | |
| 235 <dt><i>helpKeyword</i> (str)</dt> | |
| 236 <dd> | |
| 237 keyword for the documents | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <dl> | |
| 241 <dt>Return:</dt> | |
| 242 <dd> | |
| 243 selected document | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <dl> | |
| 247 <dt>Return Type:</dt> | |
| 248 <dd> | |
| 249 QHelpLink | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> | |
| 253 <h4>HelpIndexWidget.__showContextMenu</h4> | |
| 254 <b>__showContextMenu</b>(<i>pos</i>) | |
| 255 | |
| 256 <p> | |
| 257 Private slot showing the context menu. | |
| 258 </p> | |
| 259 <dl> | |
| 260 | |
| 261 <dt><i>pos</i> (QPoint)</dt> | |
| 262 <dd> | |
| 263 position to show the menu at | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> | |
| 267 <h4>HelpIndexWidget.eventFilter</h4> | |
| 268 <b>eventFilter</b>(<i>watched, event</i>) | |
| 269 | |
| 270 <p> | |
| 271 Public method called to filter the event queue. | |
| 272 </p> | |
| 273 <dl> | |
| 274 | |
| 275 <dt><i>watched</i> (QObject)</dt> | |
| 276 <dd> | |
| 277 the QObject being watched | |
| 278 </dd> | |
| 279 <dt><i>event</i> (QEvent)</dt> | |
| 280 <dd> | |
| 281 the event that occurred | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <dl> | |
| 285 <dt>Return:</dt> | |
| 286 <dd> | |
| 287 flag indicating whether the event was handled | |
| 288 </dd> | |
| 289 </dl> | |
| 290 <dl> | |
| 291 <dt>Return Type:</dt> | |
| 292 <dd> | |
| 293 bool | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> | |
| 297 <h4>HelpIndexWidget.focusInEvent</h4> | |
| 298 <b>focusInEvent</b>(<i>evt</i>) | |
| 299 | |
| 300 <p> | |
| 301 Protected method handling focus in events. | |
| 302 </p> | |
| 303 <dl> | |
| 304 | |
| 305 <dt><i>evt</i> (QFocusEvent)</dt> | |
| 306 <dd> | |
| 307 reference to the focus event object | |
| 308 </dd> | |
| 309 </dl> | |
| 310 <div align="right"><a href="#top">Up</a></div> | |
| 311 <hr /> | |
| 312 </body></html> |
