Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpTocWidget.html
eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpTocWidget.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.QtHelp.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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.WebBrowser.QtHelp.HelpTocWidget</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a window for showing the QtHelp TOC. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#HelpTocWidget">HelpTocWidget</a></td> | |
| 39 <td>Class implementing a window for showing the QtHelp TOC.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="HelpTocWidget" ID="HelpTocWidget"></a> | |
| 50 <h2>HelpTocWidget</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a window for showing the QtHelp TOC. | |
| 54 </p> | |
| 55 <h3>Signals</h3> | |
| 56 <dl> | |
| 57 | |
| 58 <dt>escapePressed()</dt> | |
| 59 <dd> | |
| 60 emitted when the ESC key was pressed | |
| 61 </dd> | |
| 62 <dt>newBackgroundTab(QUrl, str)</dt> | |
| 63 <dd> | |
| 64 emitted to open an entry in a | |
| 65 new background tab | |
| 66 </dd> | |
| 67 <dt>newTab(QUrl, str)</dt> | |
| 68 <dd> | |
| 69 emitted to open an entry in a new tab | |
| 70 </dd> | |
| 71 <dt>newWindow(QUrl, str)</dt> | |
| 72 <dd> | |
| 73 emitted to open an entry in a new window | |
| 74 </dd> | |
| 75 <dt>openUrl(QUrl, str)</dt> | |
| 76 <dd> | |
| 77 emitted to open an entry in the current tab | |
| 78 </dd> | |
| 79 </dl> | |
| 80 <h3>Derived from</h3> | |
| 81 QWidget | |
| 82 <h3>Class Attributes</h3> | |
| 83 | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 <h3>Class Methods</h3> | |
| 88 | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <h3>Methods</h3> | |
| 93 | |
| 94 <table> | |
| 95 | |
| 96 <tr> | |
| 97 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td> | |
| 98 <td>Constructor</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#HelpTocWidget.__contentsCreated">__contentsCreated</a></td> | |
| 102 <td>Private slot to be run after the contents was generated.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td> | |
| 106 <td>Private slot to expand the table of contents.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#HelpTocWidget.__linkActivated">__linkActivated</a></td> | |
| 110 <td>Private slot handling the activation of an entry.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td> | |
| 114 <td>Private slot showing the context menu.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td> | |
| 118 <td>Public slot to expand the table of contents to a specific depth.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td> | |
| 122 <td>Protected method handling focus in events.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td> | |
| 126 <td>Protected method handling key press events.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> | |
| 130 <td>Public method to sync the TOC to the displayed page.</td> | |
| 131 </tr> | |
| 132 </table> | |
| 133 <h3>Static Methods</h3> | |
| 134 | |
| 135 <table> | |
| 136 <tr><td>None</td></tr> | |
| 137 </table> | |
| 138 | |
| 139 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> | |
| 140 <h4>HelpTocWidget (Constructor)</h4> | |
| 141 <b>HelpTocWidget</b>(<i>engine, parent=None</i>) | |
| 142 | |
| 143 <p> | |
| 144 Constructor | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>engine</i></dt> | |
| 149 <dd> | |
| 150 reference to the help engine (QHelpEngine) | |
| 151 </dd> | |
| 152 <dt><i>parent</i></dt> | |
| 153 <dd> | |
| 154 reference to the parent widget (QWidget) | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a> | |
| 158 <h4>HelpTocWidget.__contentsCreated</h4> | |
| 159 <b>__contentsCreated</b>(<i></i>) | |
| 160 | |
| 161 <p> | |
| 162 Private slot to be run after the contents was generated. | |
| 163 </p> | |
| 164 <a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> | |
| 165 <h4>HelpTocWidget.__expandTOC</h4> | |
| 166 <b>__expandTOC</b>(<i></i>) | |
| 167 | |
| 168 <p> | |
| 169 Private slot to expand the table of contents. | |
| 170 </p> | |
| 171 <a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a> | |
| 172 <h4>HelpTocWidget.__linkActivated</h4> | |
| 173 <b>__linkActivated</b>(<i>url</i>) | |
| 174 | |
| 175 <p> | |
| 176 Private slot handling the activation of an entry. | |
| 177 </p> | |
| 178 <dl> | |
| 179 | |
| 180 <dt><i>url</i> (QUrl)</dt> | |
| 181 <dd> | |
| 182 URL of the activated entry | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> | |
| 186 <h4>HelpTocWidget.__showContextMenu</h4> | |
| 187 <b>__showContextMenu</b>(<i>pos</i>) | |
| 188 | |
| 189 <p> | |
| 190 Private slot showing the context menu. | |
| 191 </p> | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>pos</i></dt> | |
| 195 <dd> | |
| 196 position to show the menu at (QPoint) | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> | |
| 200 <h4>HelpTocWidget.expandToDepth</h4> | |
| 201 <b>expandToDepth</b>(<i>depth</i>) | |
| 202 | |
| 203 <p> | |
| 204 Public slot to expand the table of contents to a specific depth. | |
| 205 </p> | |
| 206 <dl> | |
| 207 | |
| 208 <dt><i>depth</i></dt> | |
| 209 <dd> | |
| 210 depth to expand to (integer) | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> | |
| 214 <h4>HelpTocWidget.focusInEvent</h4> | |
| 215 <b>focusInEvent</b>(<i>evt</i>) | |
| 216 | |
| 217 <p> | |
| 218 Protected method handling focus in events. | |
| 219 </p> | |
| 220 <dl> | |
| 221 | |
| 222 <dt><i>evt</i></dt> | |
| 223 <dd> | |
| 224 reference to the focus event object (QFocusEvent) | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> | |
| 228 <h4>HelpTocWidget.keyPressEvent</h4> | |
| 229 <b>keyPressEvent</b>(<i>evt</i>) | |
| 230 | |
| 231 <p> | |
| 232 Protected method handling key press events. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>evt</i></dt> | |
| 237 <dd> | |
| 238 reference to the key press event (QKeyEvent) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> | |
| 242 <h4>HelpTocWidget.syncToContent</h4> | |
| 243 <b>syncToContent</b>(<i>url</i>) | |
| 244 | |
| 245 <p> | |
| 246 Public method to sync the TOC to the displayed page. | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>url</i></dt> | |
| 251 <dd> | |
| 252 URL of the displayed page (QUrl) | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <dl> | |
| 256 <dt>Return:</dt> | |
| 257 <dd> | |
| 258 flag indicating a successful synchronization (boolean) | |
| 259 </dd> | |
| 260 </dl> | |
| 261 <div align="right"><a href="#top">Up</a></div> | |
| 262 <hr /> | |
| 263 </body></html> |
