Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.HelpViewer.OpenPagesWidget.html
eric7/Documentation/Source/eric7.HelpViewer.OpenPagesWidget.html
- branch
- eric7
- changeset 8752
- 3c1ea4dfb691
- child 8905
- 986278234c8a
equal
deleted
inserted
replaced
| 8751:4a6c2ccd880f | 8752:3c1ea4dfb691 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.HelpViewer.OpenPagesWidget</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.HelpViewer.OpenPagesWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a widget showing the list of open pages. | |
| 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="#OpenPagesWidget">OpenPagesWidget</a></td> | |
| 25 <td>Class implementing a widget showing the list of open pages.</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="OpenPagesWidget" ID="OpenPagesWidget"></a> | |
| 36 <h2>OpenPagesWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a widget showing the list of open pages. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>currentChanged(index)</dt> | |
| 45 <dd> | |
| 46 emitted to signal a change of the current | |
| 47 page index | |
| 48 </dd> | |
| 49 </dl> | |
| 50 <h3>Derived from</h3> | |
| 51 QWidget | |
| 52 <h3>Class Attributes</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 | |
| 66 <tr> | |
| 67 <td><a href="#OpenPagesWidget.__init__">OpenPagesWidget</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#OpenPagesWidget.__contextMenuClose">__contextMenuClose</a></td> | |
| 72 <td>Private slot to close a page via the context menu.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#OpenPagesWidget.__contextMenuCloseAll">__contextMenuCloseAll</a></td> | |
| 76 <td>Private slot to close all pages via the context menu.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#OpenPagesWidget.__contextMenuCloseOthers">__contextMenuCloseOthers</a></td> | |
| 80 <td>Private slot to close all other pages via the context menu.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#OpenPagesWidget.__contextMenuCopyUrlToClipboard">__contextMenuCopyUrlToClipboard</a></td> | |
| 84 <td>Private slot to copy the URL to the clipboard.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#OpenPagesWidget.__currentPageChanged">__currentPageChanged</a></td> | |
| 88 <td>Private slot to handle a change of the shown page.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#OpenPagesWidget.__currentRowChanged">__currentRowChanged</a></td> | |
| 92 <td>Private slot handling a change of the current row.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#OpenPagesWidget.__initContextMenu">__initContextMenu</a></td> | |
| 96 <td>Private method to initialize the context menu.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#OpenPagesWidget.__removeViewer">__removeViewer</a></td> | |
| 100 <td>Private method to remove a viewer page.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#OpenPagesWidget.__showContextMenu">__showContextMenu</a></td> | |
| 104 <td>Private slot to handle the customContextMenuRequested signal of the viewlist.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#OpenPagesWidget.__viewerTitleChanged">__viewerTitleChanged</a></td> | |
| 108 <td>Private method to handle the change of a viewer title.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#OpenPagesWidget.addPage">addPage</a></td> | |
| 112 <td>Public method to add a viewer page to our list.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#OpenPagesWidget.closeAllPages">closeAllPages</a></td> | |
| 116 <td>Public slot to close all pages.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#OpenPagesWidget.closeCurrentPage">closeCurrentPage</a></td> | |
| 120 <td>Public slot to close the current page.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#OpenPagesWidget.closeOtherPages">closeOtherPages</a></td> | |
| 124 <td>Public slot to close all other pages.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#OpenPagesWidget.insertPage">insertPage</a></td> | |
| 128 <td>Public method to insert a viewer page into our list.</td> | |
| 129 </tr> | |
| 130 </table> | |
| 131 <h3>Static Methods</h3> | |
| 132 | |
| 133 <table> | |
| 134 <tr><td>None</td></tr> | |
| 135 </table> | |
| 136 | |
| 137 <a NAME="OpenPagesWidget.__init__" ID="OpenPagesWidget.__init__"></a> | |
| 138 <h4>OpenPagesWidget (Constructor)</h4> | |
| 139 <b>OpenPagesWidget</b>(<i>stack, parent=None</i>) | |
| 140 | |
| 141 <p> | |
| 142 Constructor | |
| 143 </p> | |
| 144 <dl> | |
| 145 | |
| 146 <dt><i>stack</i> (QStackedWidget)</dt> | |
| 147 <dd> | |
| 148 reference to the stack widget containing the open | |
| 149 help pages | |
| 150 </dd> | |
| 151 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 152 <dd> | |
| 153 reference to the parent widget (defaults to None) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="OpenPagesWidget.__contextMenuClose" ID="OpenPagesWidget.__contextMenuClose"></a> | |
| 157 <h4>OpenPagesWidget.__contextMenuClose</h4> | |
| 158 <b>__contextMenuClose</b>(<i></i>) | |
| 159 | |
| 160 <p> | |
| 161 Private slot to close a page via the context menu. | |
| 162 </p> | |
| 163 <a NAME="OpenPagesWidget.__contextMenuCloseAll" ID="OpenPagesWidget.__contextMenuCloseAll"></a> | |
| 164 <h4>OpenPagesWidget.__contextMenuCloseAll</h4> | |
| 165 <b>__contextMenuCloseAll</b>(<i></i>) | |
| 166 | |
| 167 <p> | |
| 168 Private slot to close all pages via the context menu. | |
| 169 </p> | |
| 170 <a NAME="OpenPagesWidget.__contextMenuCloseOthers" ID="OpenPagesWidget.__contextMenuCloseOthers"></a> | |
| 171 <h4>OpenPagesWidget.__contextMenuCloseOthers</h4> | |
| 172 <b>__contextMenuCloseOthers</b>(<i></i>) | |
| 173 | |
| 174 <p> | |
| 175 Private slot to close all other pages via the context menu. | |
| 176 </p> | |
| 177 <a NAME="OpenPagesWidget.__contextMenuCopyUrlToClipboard" ID="OpenPagesWidget.__contextMenuCopyUrlToClipboard"></a> | |
| 178 <h4>OpenPagesWidget.__contextMenuCopyUrlToClipboard</h4> | |
| 179 <b>__contextMenuCopyUrlToClipboard</b>(<i></i>) | |
| 180 | |
| 181 <p> | |
| 182 Private slot to copy the URL to the clipboard. | |
| 183 </p> | |
| 184 <a NAME="OpenPagesWidget.__currentPageChanged" ID="OpenPagesWidget.__currentPageChanged"></a> | |
| 185 <h4>OpenPagesWidget.__currentPageChanged</h4> | |
| 186 <b>__currentPageChanged</b>(<i>index</i>) | |
| 187 | |
| 188 <p> | |
| 189 Private slot to handle a change of the shown page. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>index</i> (int)</dt> | |
| 194 <dd> | |
| 195 index of the current page | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="OpenPagesWidget.__currentRowChanged" ID="OpenPagesWidget.__currentRowChanged"></a> | |
| 199 <h4>OpenPagesWidget.__currentRowChanged</h4> | |
| 200 <b>__currentRowChanged</b>(<i>row</i>) | |
| 201 | |
| 202 <p> | |
| 203 Private slot handling a change of the current row. | |
| 204 </p> | |
| 205 <dl> | |
| 206 | |
| 207 <dt><i>row</i> (int)</dt> | |
| 208 <dd> | |
| 209 current row | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="OpenPagesWidget.__initContextMenu" ID="OpenPagesWidget.__initContextMenu"></a> | |
| 213 <h4>OpenPagesWidget.__initContextMenu</h4> | |
| 214 <b>__initContextMenu</b>(<i></i>) | |
| 215 | |
| 216 <p> | |
| 217 Private method to initialize the context menu. | |
| 218 </p> | |
| 219 <a NAME="OpenPagesWidget.__removeViewer" ID="OpenPagesWidget.__removeViewer"></a> | |
| 220 <h4>OpenPagesWidget.__removeViewer</h4> | |
| 221 <b>__removeViewer</b>(<i>row</i>) | |
| 222 | |
| 223 <p> | |
| 224 Private method to remove a viewer page. | |
| 225 </p> | |
| 226 <dl> | |
| 227 | |
| 228 <dt><i>row</i> (int)</dt> | |
| 229 <dd> | |
| 230 row associated with the viewer | |
| 231 </dd> | |
| 232 </dl> | |
| 233 <a NAME="OpenPagesWidget.__showContextMenu" ID="OpenPagesWidget.__showContextMenu"></a> | |
| 234 <h4>OpenPagesWidget.__showContextMenu</h4> | |
| 235 <b>__showContextMenu</b>(<i>point</i>) | |
| 236 | |
| 237 <p> | |
| 238 Private slot to handle the customContextMenuRequested signal of | |
| 239 the viewlist. | |
| 240 </p> | |
| 241 <dl> | |
| 242 | |
| 243 <dt><i>point</i> (QPoint)</dt> | |
| 244 <dd> | |
| 245 position to open the menu at | |
| 246 </dd> | |
| 247 </dl> | |
| 248 <a NAME="OpenPagesWidget.__viewerTitleChanged" ID="OpenPagesWidget.__viewerTitleChanged"></a> | |
| 249 <h4>OpenPagesWidget.__viewerTitleChanged</h4> | |
| 250 <b>__viewerTitleChanged</b>(<i>viewer</i>) | |
| 251 | |
| 252 <p> | |
| 253 Private method to handle the change of a viewer title. | |
| 254 </p> | |
| 255 <dl> | |
| 256 | |
| 257 <dt><i>viewer</i> (HelpViewerImpl)</dt> | |
| 258 <dd> | |
| 259 reference to the viewer that change title | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <a NAME="OpenPagesWidget.addPage" ID="OpenPagesWidget.addPage"></a> | |
| 263 <h4>OpenPagesWidget.addPage</h4> | |
| 264 <b>addPage</b>(<i>viewer, background=False</i>) | |
| 265 | |
| 266 <p> | |
| 267 Public method to add a viewer page to our list. | |
| 268 </p> | |
| 269 <dl> | |
| 270 | |
| 271 <dt><i>viewer</i> (HelpViewerImpl)</dt> | |
| 272 <dd> | |
| 273 reference to the viewer object | |
| 274 </dd> | |
| 275 <dt><i>background</i> (bool (optional))</dt> | |
| 276 <dd> | |
| 277 flag indicating to not change the current page | |
| 278 (defaults to False) | |
| 279 </dd> | |
| 280 </dl> | |
| 281 <a NAME="OpenPagesWidget.closeAllPages" ID="OpenPagesWidget.closeAllPages"></a> | |
| 282 <h4>OpenPagesWidget.closeAllPages</h4> | |
| 283 <b>closeAllPages</b>(<i></i>) | |
| 284 | |
| 285 <p> | |
| 286 Public slot to close all pages. | |
| 287 </p> | |
| 288 <a NAME="OpenPagesWidget.closeCurrentPage" ID="OpenPagesWidget.closeCurrentPage"></a> | |
| 289 <h4>OpenPagesWidget.closeCurrentPage</h4> | |
| 290 <b>closeCurrentPage</b>(<i></i>) | |
| 291 | |
| 292 <p> | |
| 293 Public slot to close the current page. | |
| 294 </p> | |
| 295 <a NAME="OpenPagesWidget.closeOtherPages" ID="OpenPagesWidget.closeOtherPages"></a> | |
| 296 <h4>OpenPagesWidget.closeOtherPages</h4> | |
| 297 <b>closeOtherPages</b>(<i></i>) | |
| 298 | |
| 299 <p> | |
| 300 Public slot to close all other pages. | |
| 301 </p> | |
| 302 <a NAME="OpenPagesWidget.insertPage" ID="OpenPagesWidget.insertPage"></a> | |
| 303 <h4>OpenPagesWidget.insertPage</h4> | |
| 304 <b>insertPage</b>(<i>index, viewer, background=False</i>) | |
| 305 | |
| 306 <p> | |
| 307 Public method to insert a viewer page into our list. | |
| 308 </p> | |
| 309 <dl> | |
| 310 | |
| 311 <dt><i>index</i> (int)</dt> | |
| 312 <dd> | |
| 313 index to insert at | |
| 314 </dd> | |
| 315 <dt><i>viewer</i> (HelpViewerImpl)</dt> | |
| 316 <dd> | |
| 317 reference to the viewer object | |
| 318 </dd> | |
| 319 <dt><i>background</i> (bool (optional))</dt> | |
| 320 <dd> | |
| 321 flag indicating to not change the current page | |
| 322 (defaults to False) | |
| 323 </dd> | |
| 324 </dl> | |
| 325 <div align="right"><a href="#top">Up</a></div> | |
| 326 <hr /> | |
| 327 </body></html> |
