Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpTocWidget.html
src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpTocWidget.html
- branch
- eric7
- changeset 9686
- 2eee7a645cba
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9685:b43e04854aba | 9686:2eee7a645cba |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QtHelpInterface.HelpTocWidget</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.HelpTocWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a window for showing the QtHelp TOC. | |
| 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="#HelpTocWidget">HelpTocWidget</a></td> | |
| 25 <td>Class implementing a window for showing the QtHelp TOC.</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="HelpTocWidget" ID="HelpTocWidget"></a> | |
| 36 <h2>HelpTocWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a window for showing the QtHelp TOC. | |
| 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="#HelpTocWidget.__init__">HelpTocWidget</a></td> | |
| 84 <td>Constructor</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#HelpTocWidget.__contentsCreated">__contentsCreated</a></td> | |
| 88 <td>Private slot to be run after the contents was generated.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td> | |
| 92 <td>Private slot to expand the table of contents.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#HelpTocWidget.__linkActivated">__linkActivated</a></td> | |
| 96 <td>Private slot handling the activation of an entry.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td> | |
| 100 <td>Private slot showing the context menu.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td> | |
| 104 <td>Public slot to expand the table of contents to a specific depth.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td> | |
| 108 <td>Protected method handling focus in events.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td> | |
| 112 <td>Protected method handling key press events.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> | |
| 116 <td>Public method to sync the TOC to the displayed page.</td> | |
| 117 </tr> | |
| 118 </table> | |
| 119 <h3>Static Methods</h3> | |
| 120 | |
| 121 <table> | |
| 122 <tr><td>None</td></tr> | |
| 123 </table> | |
| 124 | |
| 125 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> | |
| 126 <h4>HelpTocWidget (Constructor)</h4> | |
| 127 <b>HelpTocWidget</b>(<i>engine, internal=False, parent=None</i>) | |
| 128 | |
| 129 <p> | |
| 130 Constructor | |
| 131 </p> | |
| 132 <dl> | |
| 133 | |
| 134 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 135 <dd> | |
| 136 reference to the help engine | |
| 137 </dd> | |
| 138 <dt><i>internal</i> (bool)</dt> | |
| 139 <dd> | |
| 140 flag indicating the internal help viewer | |
| 141 </dd> | |
| 142 <dt><i>parent</i> (QWidget)</dt> | |
| 143 <dd> | |
| 144 reference to the parent widget | |
| 145 </dd> | |
| 146 </dl> | |
| 147 <a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a> | |
| 148 <h4>HelpTocWidget.__contentsCreated</h4> | |
| 149 <b>__contentsCreated</b>(<i></i>) | |
| 150 | |
| 151 <p> | |
| 152 Private slot to be run after the contents was generated. | |
| 153 </p> | |
| 154 <a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> | |
| 155 <h4>HelpTocWidget.__expandTOC</h4> | |
| 156 <b>__expandTOC</b>(<i></i>) | |
| 157 | |
| 158 <p> | |
| 159 Private slot to expand the table of contents. | |
| 160 </p> | |
| 161 <a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a> | |
| 162 <h4>HelpTocWidget.__linkActivated</h4> | |
| 163 <b>__linkActivated</b>(<i>url</i>) | |
| 164 | |
| 165 <p> | |
| 166 Private slot handling the activation of an entry. | |
| 167 </p> | |
| 168 <dl> | |
| 169 | |
| 170 <dt><i>url</i> (QUrl)</dt> | |
| 171 <dd> | |
| 172 URL of the activated entry | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> | |
| 176 <h4>HelpTocWidget.__showContextMenu</h4> | |
| 177 <b>__showContextMenu</b>(<i>pos</i>) | |
| 178 | |
| 179 <p> | |
| 180 Private slot showing the context menu. | |
| 181 </p> | |
| 182 <dl> | |
| 183 | |
| 184 <dt><i>pos</i></dt> | |
| 185 <dd> | |
| 186 position to show the menu at (QPoint) | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> | |
| 190 <h4>HelpTocWidget.expandToDepth</h4> | |
| 191 <b>expandToDepth</b>(<i>depth</i>) | |
| 192 | |
| 193 <p> | |
| 194 Public slot to expand the table of contents to a specific depth. | |
| 195 </p> | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>depth</i></dt> | |
| 199 <dd> | |
| 200 depth to expand to (integer) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> | |
| 204 <h4>HelpTocWidget.focusInEvent</h4> | |
| 205 <b>focusInEvent</b>(<i>evt</i>) | |
| 206 | |
| 207 <p> | |
| 208 Protected method handling focus in events. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>evt</i></dt> | |
| 213 <dd> | |
| 214 reference to the focus event object (QFocusEvent) | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> | |
| 218 <h4>HelpTocWidget.keyPressEvent</h4> | |
| 219 <b>keyPressEvent</b>(<i>evt</i>) | |
| 220 | |
| 221 <p> | |
| 222 Protected method handling key press events. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>evt</i></dt> | |
| 227 <dd> | |
| 228 reference to the key press event (QKeyEvent) | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> | |
| 232 <h4>HelpTocWidget.syncToContent</h4> | |
| 233 <b>syncToContent</b>(<i>url</i>) | |
| 234 | |
| 235 <p> | |
| 236 Public method to sync the TOC to the displayed page. | |
| 237 </p> | |
| 238 <dl> | |
| 239 | |
| 240 <dt><i>url</i></dt> | |
| 241 <dd> | |
| 242 URL of the displayed page (QUrl) | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <dl> | |
| 246 <dt>Return:</dt> | |
| 247 <dd> | |
| 248 flag indicating a successful synchronization (boolean) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <div align="right"><a href="#top">Up</a></div> | |
| 252 <hr /> | |
| 253 </body></html> |
