Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.HelpTocWidget.html
Documentation/Source/eric6.Helpviewer.HelpTocWidget.html
- changeset 3673
- e26d7d0c1088
- child 5252
- 321c2003745d
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.HelpTocWidget</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.Helpviewer.HelpTocWidget</h1> | |
| 23 <p> | |
| 24 Module implementing a window for showing the QtHelp TOC. | |
| 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="#HelpTocWidget">HelpTocWidget</a></td> | |
| 34 <td>Class implementing a window for showing the QtHelp TOC.</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="HelpTocWidget" ID="HelpTocWidget"></a> | |
| 43 <h2>HelpTocWidget</h2> | |
| 44 <p> | |
| 45 Class implementing a window for showing the QtHelp TOC. | |
| 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 a TOC entry is activated | |
| 54 </dd> | |
| 55 </dl> | |
| 56 <h3>Derived from</h3> | |
| 57 QWidget | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td> | |
| 73 <td>Private slot to expand the table of contents.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td> | |
| 76 <td>Private slot showing the context menu.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HelpTocWidget.eventFilter">eventFilter</a></td> | |
| 79 <td>Public method called to filter the event queue.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td> | |
| 82 <td>Public slot to expand the table of contents to a specific depth.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td> | |
| 85 <td>Protected method handling focus in events.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HelpTocWidget.itemClicked">itemClicked</a></td> | |
| 88 <td>Public slot handling a click of a TOC entry.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td> | |
| 91 <td>Protected method handling key press events.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> | |
| 94 <td>Public method to sync the TOC to the displayed page.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <h3>Static Methods</h3> | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> | |
| 102 <h4>HelpTocWidget (Constructor)</h4> | |
| 103 <b>HelpTocWidget</b>(<i>engine, mainWindow, parent=None</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>engine</i></dt> | |
| 108 <dd> | |
| 109 reference to the help engine (QHelpEngine) | |
| 110 </dd><dt><i>mainWindow</i></dt> | |
| 111 <dd> | |
| 112 reference to the main window object (QMainWindow) | |
| 113 </dd><dt><i>parent</i></dt> | |
| 114 <dd> | |
| 115 reference to the parent widget (QWidget) | |
| 116 </dd> | |
| 117 </dl><a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> | |
| 118 <h4>HelpTocWidget.__expandTOC</h4> | |
| 119 <b>__expandTOC</b>(<i></i>) | |
| 120 <p> | |
| 121 Private slot to expand the table of contents. | |
| 122 </p><a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> | |
| 123 <h4>HelpTocWidget.__showContextMenu</h4> | |
| 124 <b>__showContextMenu</b>(<i>pos</i>) | |
| 125 <p> | |
| 126 Private slot showing the context menu. | |
| 127 </p><dl> | |
| 128 <dt><i>pos</i></dt> | |
| 129 <dd> | |
| 130 position to show the menu at (QPoint) | |
| 131 </dd> | |
| 132 </dl><a NAME="HelpTocWidget.eventFilter" ID="HelpTocWidget.eventFilter"></a> | |
| 133 <h4>HelpTocWidget.eventFilter</h4> | |
| 134 <b>eventFilter</b>(<i>watched, event</i>) | |
| 135 <p> | |
| 136 Public method called to filter the event queue. | |
| 137 </p><dl> | |
| 138 <dt><i>watched</i></dt> | |
| 139 <dd> | |
| 140 the QObject being watched (QObject) | |
| 141 </dd><dt><i>event</i></dt> | |
| 142 <dd> | |
| 143 the event that occurred (QEvent) | |
| 144 </dd> | |
| 145 </dl><dl> | |
| 146 <dt>Returns:</dt> | |
| 147 <dd> | |
| 148 flag indicating whether the event was handled (boolean) | |
| 149 </dd> | |
| 150 </dl><a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> | |
| 151 <h4>HelpTocWidget.expandToDepth</h4> | |
| 152 <b>expandToDepth</b>(<i>depth</i>) | |
| 153 <p> | |
| 154 Public slot to expand the table of contents to a specific depth. | |
| 155 </p><dl> | |
| 156 <dt><i>depth</i></dt> | |
| 157 <dd> | |
| 158 depth to expand to (integer) | |
| 159 </dd> | |
| 160 </dl><a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> | |
| 161 <h4>HelpTocWidget.focusInEvent</h4> | |
| 162 <b>focusInEvent</b>(<i>evt</i>) | |
| 163 <p> | |
| 164 Protected method handling focus in events. | |
| 165 </p><dl> | |
| 166 <dt><i>evt</i></dt> | |
| 167 <dd> | |
| 168 reference to the focus event object (QFocusEvent) | |
| 169 </dd> | |
| 170 </dl><a NAME="HelpTocWidget.itemClicked" ID="HelpTocWidget.itemClicked"></a> | |
| 171 <h4>HelpTocWidget.itemClicked</h4> | |
| 172 <b>itemClicked</b>(<i>index</i>) | |
| 173 <p> | |
| 174 Public slot handling a click of a TOC entry. | |
| 175 </p><dl> | |
| 176 <dt><i>index</i></dt> | |
| 177 <dd> | |
| 178 index of the TOC clicked (QModelIndex) | |
| 179 </dd> | |
| 180 </dl><a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> | |
| 181 <h4>HelpTocWidget.keyPressEvent</h4> | |
| 182 <b>keyPressEvent</b>(<i>evt</i>) | |
| 183 <p> | |
| 184 Protected method handling key press events. | |
| 185 </p><dl> | |
| 186 <dt><i>evt</i></dt> | |
| 187 <dd> | |
| 188 reference to the key press event (QKeyEvent) | |
| 189 </dd> | |
| 190 </dl><a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> | |
| 191 <h4>HelpTocWidget.syncToContent</h4> | |
| 192 <b>syncToContent</b>(<i>url</i>) | |
| 193 <p> | |
| 194 Public method to sync the TOC to the displayed page. | |
| 195 </p><dl> | |
| 196 <dt><i>url</i></dt> | |
| 197 <dd> | |
| 198 URL of the displayed page (QUrl) | |
| 199 </dd> | |
| 200 </dl><dl> | |
| 201 <dt>Returns:</dt> | |
| 202 <dd> | |
| 203 flag indicating a successful synchronization (boolean) | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <div align="right"><a href="#top">Up</a></div> | |
| 207 <hr /> | |
| 208 </body></html> |
