Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PdfViewer.PdfViewerWindow.html
src/eric7/Documentation/Source/eric7.PdfViewer.PdfViewerWindow.html
- branch
- eric7
- changeset 9730
- 00cf7289d899
- child 10428
- a071d4065202
equal
deleted
inserted
replaced
| 9729:f17d787ca4fa | 9730:00cf7289d899 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PdfViewer.PdfViewerWindow</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.PdfViewer.PdfViewerWindow</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the PDF viewer main window. | |
| 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="#PdfViewerWindow">PdfViewerWindow</a></td> | |
| 25 <td>Class implementing the PDF viewer main window.</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="PdfViewerWindow" ID="PdfViewerWindow"></a> | |
| 36 <h2>PdfViewerWindow</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the PDF viewer main window. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>viewerClosed()</dt> | |
| 45 <dd> | |
| 46 emitted after the window was requested to close | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 EricMainWindow | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>maxMenuFilePathLen</td></tr><tr><td>windows</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#PdfViewerWindow.__init__">PdfViewerWindow</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PdfViewerWindow.__about">__about</a></td> | |
| 71 <td>Private slot to show a little About message.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PdfViewerWindow.__aboutQt">__aboutQt</a></td> | |
| 75 <td>Private slot to handle the About Qt dialog.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PdfViewerWindow.__addToRecentList">__addToRecentList</a></td> | |
| 79 <td>Private method to add a file name to the list of recently opened files.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PdfViewerWindow.__backInHistory">__backInHistory</a></td> | |
| 83 <td>Private slot to go back in the view history.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PdfViewerWindow.__checkActions">__checkActions</a></td> | |
| 87 <td>Private slot to check some actions for their enable/disable status.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PdfViewerWindow.__clearRecent">__clearRecent</a></td> | |
| 91 <td>Private method to clear the list of recently opened files.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PdfViewerWindow.__closeAll">__closeAll</a></td> | |
| 95 <td>Private slot to close all windows.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PdfViewerWindow.__closeOthers">__closeOthers</a></td> | |
| 99 <td>Private slot to close all other windows.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PdfViewerWindow.__copyAllText">__copyAllText</a></td> | |
| 103 <td>Private slot to copy all text of the document to the system clipboard.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PdfViewerWindow.__copyAllTextOfPage">__copyAllTextOfPage</a></td> | |
| 107 <td>Private slot to copy all text of the current page to the system clipboard.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PdfViewerWindow.__copyText">__copyText</a></td> | |
| 111 <td>Private slot to copy the selected text to the system clipboard.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PdfViewerWindow.__createStatusBar">__createStatusBar</a></td> | |
| 115 <td>Private method to initialize the status bar.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#PdfViewerWindow.__displayModeSelected">__displayModeSelected</a></td> | |
| 119 <td>Private slot to handle the selection of a display mode.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#PdfViewerWindow.__endDocument">__endDocument</a></td> | |
| 123 <td>Private slot to go to the last page of the document.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#PdfViewerWindow.__forwardInHistory">__forwardInHistory</a></td> | |
| 127 <td>Private slot to go forward in the view history.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#PdfViewerWindow.__getErrorString">__getErrorString</a></td> | |
| 131 <td>Private method to get an error string for the given error.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#PdfViewerWindow.__gotoPage">__gotoPage</a></td> | |
| 135 <td>Private slot to show a dialog to select a page to jump to.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#PdfViewerWindow.__handleSearchResult">__handleSearchResult</a></td> | |
| 139 <td>Private slot to handle the selection of a search result.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#PdfViewerWindow.__initActions">__initActions</a></td> | |
| 143 <td>Private method to define the user interface actions.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#PdfViewerWindow.__initEditActions">__initEditActions</a></td> | |
| 147 <td>Private method to create the Edit actions.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#PdfViewerWindow.__initFileActions">__initFileActions</a></td> | |
| 151 <td>Private method to define the file related user interface actions.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#PdfViewerWindow.__initGotoActions">__initGotoActions</a></td> | |
| 155 <td>Private method to define the navigation related user interface actions.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#PdfViewerWindow.__initHelpActions">__initHelpActions</a></td> | |
| 159 <td>Private method to create the Help actions.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#PdfViewerWindow.__initMenus">__initMenus</a></td> | |
| 163 <td>Private method to create the menus.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#PdfViewerWindow.__initSettingsActions">__initSettingsActions</a></td> | |
| 167 <td>Private method to create the Settings actions.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#PdfViewerWindow.__initToolbars">__initToolbars</a></td> | |
| 171 <td>Private method to create the toolbars.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#PdfViewerWindow.__initViewActions">__initViewActions</a></td> | |
| 175 <td>Private method to define the view related user interface actions.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#PdfViewerWindow.__loadPdfFile">__loadPdfFile</a></td> | |
| 179 <td>Private method to load a PDF file.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#PdfViewerWindow.__loadRecent">__loadRecent</a></td> | |
| 183 <td>Private method to load the list of recently opened files.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#PdfViewerWindow.__nextPage">__nextPage</a></td> | |
| 187 <td>Private slot to go to the next page.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#PdfViewerWindow.__openPdfFile">__openPdfFile</a></td> | |
| 191 <td>Private slot to open a PDF file.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#PdfViewerWindow.__openPdfFileNewWindow">__openPdfFileNewWindow</a></td> | |
| 195 <td>Private slot called to open a PDF file in new viewer window.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#PdfViewerWindow.__openRecentPdfFile">__openRecentPdfFile</a></td> | |
| 199 <td>Private method to open a file from the list of recently opened files.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#PdfViewerWindow.__pageSelected">__pageSelected</a></td> | |
| 203 <td>Private slot to navigate to the given page.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#PdfViewerWindow.__previousPage">__previousPage</a></td> | |
| 207 <td>Private slot to go to the previous page.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#PdfViewerWindow.__reload">__reload</a></td> | |
| 211 <td>Private slot to reload the current PDF document.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#PdfViewerWindow.__restoreViewerState">__restoreViewerState</a></td> | |
| 215 <td>Private method to restore the PDF Viewer state data.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#PdfViewerWindow.__saveRecent">__saveRecent</a></td> | |
| 219 <td>Private method to save the list of recently opened files.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#PdfViewerWindow.__saveViewerState">__saveViewerState</a></td> | |
| 223 <td>Private method to save the PDF Viewer state data.</td> | |
| 224 </tr> | |
| 225 <tr> | |
| 226 <td><a href="#PdfViewerWindow.__search">__search</a></td> | |
| 227 <td>Private slot to initiate a search.</td> | |
| 228 </tr> | |
| 229 <tr> | |
| 230 <td><a href="#PdfViewerWindow.__setCurrentFile">__setCurrentFile</a></td> | |
| 231 <td>Private method to register the file name of the current file.</td> | |
| 232 </tr> | |
| 233 <tr> | |
| 234 <td><a href="#PdfViewerWindow.__setDisplayMode">__setDisplayMode</a></td> | |
| 235 <td>Private method to set the display mode iaw.</td> | |
| 236 </tr> | |
| 237 <tr> | |
| 238 <td><a href="#PdfViewerWindow.__setViewerTitle">__setViewerTitle</a></td> | |
| 239 <td>Private method to set the viewer title.</td> | |
| 240 </tr> | |
| 241 <tr> | |
| 242 <td><a href="#PdfViewerWindow.__showDocumentProperties">__showDocumentProperties</a></td> | |
| 243 <td>Private slot to open a dialog showing the document properties.</td> | |
| 244 </tr> | |
| 245 <tr> | |
| 246 <td><a href="#PdfViewerWindow.__showFileMenu">__showFileMenu</a></td> | |
| 247 <td>Private slot to modify the file menu before being shown.</td> | |
| 248 </tr> | |
| 249 <tr> | |
| 250 <td><a href="#PdfViewerWindow.__showPreferences">__showPreferences</a></td> | |
| 251 <td>Private slot to set the preferences.</td> | |
| 252 </tr> | |
| 253 <tr> | |
| 254 <td><a href="#PdfViewerWindow.__showRecentMenu">__showRecentMenu</a></td> | |
| 255 <td>Private slot to set up the recent files menu.</td> | |
| 256 </tr> | |
| 257 <tr> | |
| 258 <td><a href="#PdfViewerWindow.__startDocument">__startDocument</a></td> | |
| 259 <td>Private slot to go to the first page of the document.</td> | |
| 260 </tr> | |
| 261 <tr> | |
| 262 <td><a href="#PdfViewerWindow.__tocActivated">__tocActivated</a></td> | |
| 263 <td>Private slot to handle the selection of a ToC topic.</td> | |
| 264 </tr> | |
| 265 <tr> | |
| 266 <td><a href="#PdfViewerWindow.__toggleFullScreen">__toggleFullScreen</a></td> | |
| 267 <td>Private slot to toggle the full screen mode.</td> | |
| 268 </tr> | |
| 269 <tr> | |
| 270 <td><a href="#PdfViewerWindow.__toggleOpenRecentNew">__toggleOpenRecentNew</a></td> | |
| 271 <td>Private slot to toggle the 'Open Recent File in New Window' action.</td> | |
| 272 </tr> | |
| 273 <tr> | |
| 274 <td><a href="#PdfViewerWindow.__toggleSideBar">__toggleSideBar</a></td> | |
| 275 <td>Private slot to togle the sidebar (info) widget.</td> | |
| 276 </tr> | |
| 277 <tr> | |
| 278 <td><a href="#PdfViewerWindow.__whatsThis">__whatsThis</a></td> | |
| 279 <td>Private slot called in to enter Whats This mode.</td> | |
| 280 </tr> | |
| 281 <tr> | |
| 282 <td><a href="#PdfViewerWindow.__zoomIn">__zoomIn</a></td> | |
| 283 <td>Private slot to zoom into the view.</td> | |
| 284 </tr> | |
| 285 <tr> | |
| 286 <td><a href="#PdfViewerWindow.__zoomModeChanged">__zoomModeChanged</a></td> | |
| 287 <td>Private slot to handle a change of the zoom mode.</td> | |
| 288 </tr> | |
| 289 <tr> | |
| 290 <td><a href="#PdfViewerWindow.__zoomOut">__zoomOut</a></td> | |
| 291 <td>Private slot to zoom out of the view.</td> | |
| 292 </tr> | |
| 293 <tr> | |
| 294 <td><a href="#PdfViewerWindow.__zoomPageWidth">__zoomPageWidth</a></td> | |
| 295 <td>Private slot to fit the page width.</td> | |
| 296 </tr> | |
| 297 <tr> | |
| 298 <td><a href="#PdfViewerWindow.__zoomReset">__zoomReset</a></td> | |
| 299 <td>Private slot to reset the zoom factor of the view.</td> | |
| 300 </tr> | |
| 301 <tr> | |
| 302 <td><a href="#PdfViewerWindow.__zoomWholePage">__zoomWholePage</a></td> | |
| 303 <td>Private slot to fit the page width.</td> | |
| 304 </tr> | |
| 305 <tr> | |
| 306 <td><a href="#PdfViewerWindow.closeEvent">closeEvent</a></td> | |
| 307 <td>Protected method handling the close event.</td> | |
| 308 </tr> | |
| 309 </table> | |
| 310 <h3>Static Methods</h3> | |
| 311 | |
| 312 <table> | |
| 313 <tr><td>None</td></tr> | |
| 314 </table> | |
| 315 | |
| 316 <a NAME="PdfViewerWindow.__init__" ID="PdfViewerWindow.__init__"></a> | |
| 317 <h4>PdfViewerWindow (Constructor)</h4> | |
| 318 <b>PdfViewerWindow</b>(<i>fileName="", parent=None, fromEric=False, project=None</i>) | |
| 319 | |
| 320 <p> | |
| 321 Constructor | |
| 322 </p> | |
| 323 <dl> | |
| 324 | |
| 325 <dt><i>fileName</i> (str)</dt> | |
| 326 <dd> | |
| 327 name of a file to load on startup | |
| 328 </dd> | |
| 329 <dt><i>parent</i> (QWidget)</dt> | |
| 330 <dd> | |
| 331 parent widget of this window | |
| 332 </dd> | |
| 333 <dt><i>fromEric</i> (bool)</dt> | |
| 334 <dd> | |
| 335 flag indicating whether it was called from within | |
| 336 eric | |
| 337 </dd> | |
| 338 <dt><i>project</i> (Project)</dt> | |
| 339 <dd> | |
| 340 reference to the project object | |
| 341 </dd> | |
| 342 </dl> | |
| 343 <a NAME="PdfViewerWindow.__about" ID="PdfViewerWindow.__about"></a> | |
| 344 <h4>PdfViewerWindow.__about</h4> | |
| 345 <b>__about</b>(<i></i>) | |
| 346 | |
| 347 <p> | |
| 348 Private slot to show a little About message. | |
| 349 </p> | |
| 350 <a NAME="PdfViewerWindow.__aboutQt" ID="PdfViewerWindow.__aboutQt"></a> | |
| 351 <h4>PdfViewerWindow.__aboutQt</h4> | |
| 352 <b>__aboutQt</b>(<i></i>) | |
| 353 | |
| 354 <p> | |
| 355 Private slot to handle the About Qt dialog. | |
| 356 </p> | |
| 357 <a NAME="PdfViewerWindow.__addToRecentList" ID="PdfViewerWindow.__addToRecentList"></a> | |
| 358 <h4>PdfViewerWindow.__addToRecentList</h4> | |
| 359 <b>__addToRecentList</b>(<i>fileName</i>) | |
| 360 | |
| 361 <p> | |
| 362 Private method to add a file name to the list of recently opened files. | |
| 363 </p> | |
| 364 <dl> | |
| 365 | |
| 366 <dt><i>fileName</i></dt> | |
| 367 <dd> | |
| 368 name of the file to be added | |
| 369 </dd> | |
| 370 </dl> | |
| 371 <a NAME="PdfViewerWindow.__backInHistory" ID="PdfViewerWindow.__backInHistory"></a> | |
| 372 <h4>PdfViewerWindow.__backInHistory</h4> | |
| 373 <b>__backInHistory</b>(<i></i>) | |
| 374 | |
| 375 <p> | |
| 376 Private slot to go back in the view history. | |
| 377 </p> | |
| 378 <a NAME="PdfViewerWindow.__checkActions" ID="PdfViewerWindow.__checkActions"></a> | |
| 379 <h4>PdfViewerWindow.__checkActions</h4> | |
| 380 <b>__checkActions</b>(<i></i>) | |
| 381 | |
| 382 <p> | |
| 383 Private slot to check some actions for their enable/disable status. | |
| 384 </p> | |
| 385 <a NAME="PdfViewerWindow.__clearRecent" ID="PdfViewerWindow.__clearRecent"></a> | |
| 386 <h4>PdfViewerWindow.__clearRecent</h4> | |
| 387 <b>__clearRecent</b>(<i></i>) | |
| 388 | |
| 389 <p> | |
| 390 Private method to clear the list of recently opened files. | |
| 391 </p> | |
| 392 <a NAME="PdfViewerWindow.__closeAll" ID="PdfViewerWindow.__closeAll"></a> | |
| 393 <h4>PdfViewerWindow.__closeAll</h4> | |
| 394 <b>__closeAll</b>(<i></i>) | |
| 395 | |
| 396 <p> | |
| 397 Private slot to close all windows. | |
| 398 </p> | |
| 399 <a NAME="PdfViewerWindow.__closeOthers" ID="PdfViewerWindow.__closeOthers"></a> | |
| 400 <h4>PdfViewerWindow.__closeOthers</h4> | |
| 401 <b>__closeOthers</b>(<i></i>) | |
| 402 | |
| 403 <p> | |
| 404 Private slot to close all other windows. | |
| 405 </p> | |
| 406 <a NAME="PdfViewerWindow.__copyAllText" ID="PdfViewerWindow.__copyAllText"></a> | |
| 407 <h4>PdfViewerWindow.__copyAllText</h4> | |
| 408 <b>__copyAllText</b>(<i></i>) | |
| 409 | |
| 410 <p> | |
| 411 Private slot to copy all text of the document to the system clipboard. | |
| 412 </p> | |
| 413 <a NAME="PdfViewerWindow.__copyAllTextOfPage" ID="PdfViewerWindow.__copyAllTextOfPage"></a> | |
| 414 <h4>PdfViewerWindow.__copyAllTextOfPage</h4> | |
| 415 <b>__copyAllTextOfPage</b>(<i></i>) | |
| 416 | |
| 417 <p> | |
| 418 Private slot to copy all text of the current page to the system clipboard. | |
| 419 </p> | |
| 420 <a NAME="PdfViewerWindow.__copyText" ID="PdfViewerWindow.__copyText"></a> | |
| 421 <h4>PdfViewerWindow.__copyText</h4> | |
| 422 <b>__copyText</b>(<i></i>) | |
| 423 | |
| 424 <p> | |
| 425 Private slot to copy the selected text to the system clipboard. | |
| 426 </p> | |
| 427 <a NAME="PdfViewerWindow.__createStatusBar" ID="PdfViewerWindow.__createStatusBar"></a> | |
| 428 <h4>PdfViewerWindow.__createStatusBar</h4> | |
| 429 <b>__createStatusBar</b>(<i></i>) | |
| 430 | |
| 431 <p> | |
| 432 Private method to initialize the status bar. | |
| 433 </p> | |
| 434 <a NAME="PdfViewerWindow.__displayModeSelected" ID="PdfViewerWindow.__displayModeSelected"></a> | |
| 435 <h4>PdfViewerWindow.__displayModeSelected</h4> | |
| 436 <b>__displayModeSelected</b>(<i>act</i>) | |
| 437 | |
| 438 <p> | |
| 439 Private slot to handle the selection of a display mode. | |
| 440 </p> | |
| 441 <dl> | |
| 442 | |
| 443 <dt><i>act</i> (QAction)</dt> | |
| 444 <dd> | |
| 445 reference to the triggering action | |
| 446 </dd> | |
| 447 </dl> | |
| 448 <a NAME="PdfViewerWindow.__endDocument" ID="PdfViewerWindow.__endDocument"></a> | |
| 449 <h4>PdfViewerWindow.__endDocument</h4> | |
| 450 <b>__endDocument</b>(<i></i>) | |
| 451 | |
| 452 <p> | |
| 453 Private slot to go to the last page of the document. | |
| 454 </p> | |
| 455 <a NAME="PdfViewerWindow.__forwardInHistory" ID="PdfViewerWindow.__forwardInHistory"></a> | |
| 456 <h4>PdfViewerWindow.__forwardInHistory</h4> | |
| 457 <b>__forwardInHistory</b>(<i></i>) | |
| 458 | |
| 459 <p> | |
| 460 Private slot to go forward in the view history. | |
| 461 </p> | |
| 462 <a NAME="PdfViewerWindow.__getErrorString" ID="PdfViewerWindow.__getErrorString"></a> | |
| 463 <h4>PdfViewerWindow.__getErrorString</h4> | |
| 464 <b>__getErrorString</b>(<i>err</i>) | |
| 465 | |
| 466 <p> | |
| 467 Private method to get an error string for the given error. | |
| 468 </p> | |
| 469 <dl> | |
| 470 | |
| 471 <dt><i>err</i> (QPdfDocument.Error)</dt> | |
| 472 <dd> | |
| 473 error type | |
| 474 </dd> | |
| 475 </dl> | |
| 476 <dl> | |
| 477 <dt>Return:</dt> | |
| 478 <dd> | |
| 479 string for the given error type | |
| 480 </dd> | |
| 481 </dl> | |
| 482 <dl> | |
| 483 <dt>Return Type:</dt> | |
| 484 <dd> | |
| 485 str | |
| 486 </dd> | |
| 487 </dl> | |
| 488 <a NAME="PdfViewerWindow.__gotoPage" ID="PdfViewerWindow.__gotoPage"></a> | |
| 489 <h4>PdfViewerWindow.__gotoPage</h4> | |
| 490 <b>__gotoPage</b>(<i></i>) | |
| 491 | |
| 492 <p> | |
| 493 Private slot to show a dialog to select a page to jump to. | |
| 494 </p> | |
| 495 <a NAME="PdfViewerWindow.__handleSearchResult" ID="PdfViewerWindow.__handleSearchResult"></a> | |
| 496 <h4>PdfViewerWindow.__handleSearchResult</h4> | |
| 497 <b>__handleSearchResult</b>(<i>link</i>) | |
| 498 | |
| 499 <p> | |
| 500 Private slot to handle the selection of a search result. | |
| 501 </p> | |
| 502 <dl> | |
| 503 | |
| 504 <dt><i>link</i> (QPdfLink)</dt> | |
| 505 <dd> | |
| 506 PDF link to navigate to | |
| 507 </dd> | |
| 508 </dl> | |
| 509 <a NAME="PdfViewerWindow.__initActions" ID="PdfViewerWindow.__initActions"></a> | |
| 510 <h4>PdfViewerWindow.__initActions</h4> | |
| 511 <b>__initActions</b>(<i></i>) | |
| 512 | |
| 513 <p> | |
| 514 Private method to define the user interface actions. | |
| 515 </p> | |
| 516 <a NAME="PdfViewerWindow.__initEditActions" ID="PdfViewerWindow.__initEditActions"></a> | |
| 517 <h4>PdfViewerWindow.__initEditActions</h4> | |
| 518 <b>__initEditActions</b>(<i></i>) | |
| 519 | |
| 520 <p> | |
| 521 Private method to create the Edit actions. | |
| 522 </p> | |
| 523 <a NAME="PdfViewerWindow.__initFileActions" ID="PdfViewerWindow.__initFileActions"></a> | |
| 524 <h4>PdfViewerWindow.__initFileActions</h4> | |
| 525 <b>__initFileActions</b>(<i></i>) | |
| 526 | |
| 527 <p> | |
| 528 Private method to define the file related user interface actions. | |
| 529 </p> | |
| 530 <a NAME="PdfViewerWindow.__initGotoActions" ID="PdfViewerWindow.__initGotoActions"></a> | |
| 531 <h4>PdfViewerWindow.__initGotoActions</h4> | |
| 532 <b>__initGotoActions</b>(<i></i>) | |
| 533 | |
| 534 <p> | |
| 535 Private method to define the navigation related user interface actions. | |
| 536 </p> | |
| 537 <a NAME="PdfViewerWindow.__initHelpActions" ID="PdfViewerWindow.__initHelpActions"></a> | |
| 538 <h4>PdfViewerWindow.__initHelpActions</h4> | |
| 539 <b>__initHelpActions</b>(<i></i>) | |
| 540 | |
| 541 <p> | |
| 542 Private method to create the Help actions. | |
| 543 </p> | |
| 544 <a NAME="PdfViewerWindow.__initMenus" ID="PdfViewerWindow.__initMenus"></a> | |
| 545 <h4>PdfViewerWindow.__initMenus</h4> | |
| 546 <b>__initMenus</b>(<i></i>) | |
| 547 | |
| 548 <p> | |
| 549 Private method to create the menus. | |
| 550 </p> | |
| 551 <a NAME="PdfViewerWindow.__initSettingsActions" ID="PdfViewerWindow.__initSettingsActions"></a> | |
| 552 <h4>PdfViewerWindow.__initSettingsActions</h4> | |
| 553 <b>__initSettingsActions</b>(<i></i>) | |
| 554 | |
| 555 <p> | |
| 556 Private method to create the Settings actions. | |
| 557 </p> | |
| 558 <a NAME="PdfViewerWindow.__initToolbars" ID="PdfViewerWindow.__initToolbars"></a> | |
| 559 <h4>PdfViewerWindow.__initToolbars</h4> | |
| 560 <b>__initToolbars</b>(<i></i>) | |
| 561 | |
| 562 <p> | |
| 563 Private method to create the toolbars. | |
| 564 </p> | |
| 565 <a NAME="PdfViewerWindow.__initViewActions" ID="PdfViewerWindow.__initViewActions"></a> | |
| 566 <h4>PdfViewerWindow.__initViewActions</h4> | |
| 567 <b>__initViewActions</b>(<i></i>) | |
| 568 | |
| 569 <p> | |
| 570 Private method to define the view related user interface actions. | |
| 571 </p> | |
| 572 <a NAME="PdfViewerWindow.__loadPdfFile" ID="PdfViewerWindow.__loadPdfFile"></a> | |
| 573 <h4>PdfViewerWindow.__loadPdfFile</h4> | |
| 574 <b>__loadPdfFile</b>(<i>fileName</i>) | |
| 575 | |
| 576 <p> | |
| 577 Private method to load a PDF file. | |
| 578 </p> | |
| 579 <dl> | |
| 580 | |
| 581 <dt><i>fileName</i> (str)</dt> | |
| 582 <dd> | |
| 583 path of the PDF file to load | |
| 584 </dd> | |
| 585 </dl> | |
| 586 <a NAME="PdfViewerWindow.__loadRecent" ID="PdfViewerWindow.__loadRecent"></a> | |
| 587 <h4>PdfViewerWindow.__loadRecent</h4> | |
| 588 <b>__loadRecent</b>(<i></i>) | |
| 589 | |
| 590 <p> | |
| 591 Private method to load the list of recently opened files. | |
| 592 </p> | |
| 593 <a NAME="PdfViewerWindow.__nextPage" ID="PdfViewerWindow.__nextPage"></a> | |
| 594 <h4>PdfViewerWindow.__nextPage</h4> | |
| 595 <b>__nextPage</b>(<i></i>) | |
| 596 | |
| 597 <p> | |
| 598 Private slot to go to the next page. | |
| 599 </p> | |
| 600 <a NAME="PdfViewerWindow.__openPdfFile" ID="PdfViewerWindow.__openPdfFile"></a> | |
| 601 <h4>PdfViewerWindow.__openPdfFile</h4> | |
| 602 <b>__openPdfFile</b>(<i></i>) | |
| 603 | |
| 604 <p> | |
| 605 Private slot to open a PDF file. | |
| 606 </p> | |
| 607 <a NAME="PdfViewerWindow.__openPdfFileNewWindow" ID="PdfViewerWindow.__openPdfFileNewWindow"></a> | |
| 608 <h4>PdfViewerWindow.__openPdfFileNewWindow</h4> | |
| 609 <b>__openPdfFileNewWindow</b>(<i>fileName=""</i>) | |
| 610 | |
| 611 <p> | |
| 612 Private slot called to open a PDF file in new viewer window. | |
| 613 </p> | |
| 614 <dl> | |
| 615 | |
| 616 <dt><i>fileName</i> (str (optional))</dt> | |
| 617 <dd> | |
| 618 name of the file to open (defaults to "") | |
| 619 </dd> | |
| 620 </dl> | |
| 621 <a NAME="PdfViewerWindow.__openRecentPdfFile" ID="PdfViewerWindow.__openRecentPdfFile"></a> | |
| 622 <h4>PdfViewerWindow.__openRecentPdfFile</h4> | |
| 623 <b>__openRecentPdfFile</b>(<i>act</i>) | |
| 624 | |
| 625 <p> | |
| 626 Private method to open a file from the list of recently opened files. | |
| 627 </p> | |
| 628 <dl> | |
| 629 | |
| 630 <dt><i>act</i> (QAction)</dt> | |
| 631 <dd> | |
| 632 reference to the action that triggered | |
| 633 </dd> | |
| 634 </dl> | |
| 635 <a NAME="PdfViewerWindow.__pageSelected" ID="PdfViewerWindow.__pageSelected"></a> | |
| 636 <h4>PdfViewerWindow.__pageSelected</h4> | |
| 637 <b>__pageSelected</b>(<i>page</i>) | |
| 638 | |
| 639 <p> | |
| 640 Private slot to navigate to the given page. | |
| 641 </p> | |
| 642 <dl> | |
| 643 | |
| 644 <dt><i>page</i> (int)</dt> | |
| 645 <dd> | |
| 646 index of the page to be shown | |
| 647 </dd> | |
| 648 </dl> | |
| 649 <a NAME="PdfViewerWindow.__previousPage" ID="PdfViewerWindow.__previousPage"></a> | |
| 650 <h4>PdfViewerWindow.__previousPage</h4> | |
| 651 <b>__previousPage</b>(<i></i>) | |
| 652 | |
| 653 <p> | |
| 654 Private slot to go to the previous page. | |
| 655 </p> | |
| 656 <a NAME="PdfViewerWindow.__reload" ID="PdfViewerWindow.__reload"></a> | |
| 657 <h4>PdfViewerWindow.__reload</h4> | |
| 658 <b>__reload</b>(<i></i>) | |
| 659 | |
| 660 <p> | |
| 661 Private slot to reload the current PDF document. | |
| 662 </p> | |
| 663 <a NAME="PdfViewerWindow.__restoreViewerState" ID="PdfViewerWindow.__restoreViewerState"></a> | |
| 664 <h4>PdfViewerWindow.__restoreViewerState</h4> | |
| 665 <b>__restoreViewerState</b>(<i></i>) | |
| 666 | |
| 667 <p> | |
| 668 Private method to restore the PDF Viewer state data. | |
| 669 </p> | |
| 670 <a NAME="PdfViewerWindow.__saveRecent" ID="PdfViewerWindow.__saveRecent"></a> | |
| 671 <h4>PdfViewerWindow.__saveRecent</h4> | |
| 672 <b>__saveRecent</b>(<i></i>) | |
| 673 | |
| 674 <p> | |
| 675 Private method to save the list of recently opened files. | |
| 676 </p> | |
| 677 <a NAME="PdfViewerWindow.__saveViewerState" ID="PdfViewerWindow.__saveViewerState"></a> | |
| 678 <h4>PdfViewerWindow.__saveViewerState</h4> | |
| 679 <b>__saveViewerState</b>(<i></i>) | |
| 680 | |
| 681 <p> | |
| 682 Private method to save the PDF Viewer state data. | |
| 683 </p> | |
| 684 <a NAME="PdfViewerWindow.__search" ID="PdfViewerWindow.__search"></a> | |
| 685 <h4>PdfViewerWindow.__search</h4> | |
| 686 <b>__search</b>(<i></i>) | |
| 687 | |
| 688 <p> | |
| 689 Private slot to initiate a search. | |
| 690 </p> | |
| 691 <a NAME="PdfViewerWindow.__setCurrentFile" ID="PdfViewerWindow.__setCurrentFile"></a> | |
| 692 <h4>PdfViewerWindow.__setCurrentFile</h4> | |
| 693 <b>__setCurrentFile</b>(<i>fileName</i>) | |
| 694 | |
| 695 <p> | |
| 696 Private method to register the file name of the current file. | |
| 697 </p> | |
| 698 <dl> | |
| 699 | |
| 700 <dt><i>fileName</i> (str)</dt> | |
| 701 <dd> | |
| 702 name of the file to register | |
| 703 </dd> | |
| 704 </dl> | |
| 705 <a NAME="PdfViewerWindow.__setDisplayMode" ID="PdfViewerWindow.__setDisplayMode"></a> | |
| 706 <h4>PdfViewerWindow.__setDisplayMode</h4> | |
| 707 <b>__setDisplayMode</b>(<i></i>) | |
| 708 | |
| 709 <p> | |
| 710 Private method to set the display mode iaw. configuration. | |
| 711 </p> | |
| 712 <a NAME="PdfViewerWindow.__setViewerTitle" ID="PdfViewerWindow.__setViewerTitle"></a> | |
| 713 <h4>PdfViewerWindow.__setViewerTitle</h4> | |
| 714 <b>__setViewerTitle</b>(<i>title</i>) | |
| 715 | |
| 716 <p> | |
| 717 Private method to set the viewer title. | |
| 718 </p> | |
| 719 <dl> | |
| 720 | |
| 721 <dt><i>title</i> (str)</dt> | |
| 722 <dd> | |
| 723 title to be set | |
| 724 </dd> | |
| 725 </dl> | |
| 726 <a NAME="PdfViewerWindow.__showDocumentProperties" ID="PdfViewerWindow.__showDocumentProperties"></a> | |
| 727 <h4>PdfViewerWindow.__showDocumentProperties</h4> | |
| 728 <b>__showDocumentProperties</b>(<i></i>) | |
| 729 | |
| 730 <p> | |
| 731 Private slot to open a dialog showing the document properties. | |
| 732 </p> | |
| 733 <a NAME="PdfViewerWindow.__showFileMenu" ID="PdfViewerWindow.__showFileMenu"></a> | |
| 734 <h4>PdfViewerWindow.__showFileMenu</h4> | |
| 735 <b>__showFileMenu</b>(<i></i>) | |
| 736 | |
| 737 <p> | |
| 738 Private slot to modify the file menu before being shown. | |
| 739 </p> | |
| 740 <a NAME="PdfViewerWindow.__showPreferences" ID="PdfViewerWindow.__showPreferences"></a> | |
| 741 <h4>PdfViewerWindow.__showPreferences</h4> | |
| 742 <b>__showPreferences</b>(<i></i>) | |
| 743 | |
| 744 <p> | |
| 745 Private slot to set the preferences. | |
| 746 </p> | |
| 747 <a NAME="PdfViewerWindow.__showRecentMenu" ID="PdfViewerWindow.__showRecentMenu"></a> | |
| 748 <h4>PdfViewerWindow.__showRecentMenu</h4> | |
| 749 <b>__showRecentMenu</b>(<i></i>) | |
| 750 | |
| 751 <p> | |
| 752 Private slot to set up the recent files menu. | |
| 753 </p> | |
| 754 <a NAME="PdfViewerWindow.__startDocument" ID="PdfViewerWindow.__startDocument"></a> | |
| 755 <h4>PdfViewerWindow.__startDocument</h4> | |
| 756 <b>__startDocument</b>(<i></i>) | |
| 757 | |
| 758 <p> | |
| 759 Private slot to go to the first page of the document. | |
| 760 </p> | |
| 761 <a NAME="PdfViewerWindow.__tocActivated" ID="PdfViewerWindow.__tocActivated"></a> | |
| 762 <h4>PdfViewerWindow.__tocActivated</h4> | |
| 763 <b>__tocActivated</b>(<i>page, zoomFactor</i>) | |
| 764 | |
| 765 <p> | |
| 766 Private slot to handle the selection of a ToC topic. | |
| 767 </p> | |
| 768 <dl> | |
| 769 | |
| 770 <dt><i>page</i> (int)</dt> | |
| 771 <dd> | |
| 772 page number | |
| 773 </dd> | |
| 774 <dt><i>zoomFactor</i> (float)</dt> | |
| 775 <dd> | |
| 776 zoom factor | |
| 777 </dd> | |
| 778 </dl> | |
| 779 <a NAME="PdfViewerWindow.__toggleFullScreen" ID="PdfViewerWindow.__toggleFullScreen"></a> | |
| 780 <h4>PdfViewerWindow.__toggleFullScreen</h4> | |
| 781 <b>__toggleFullScreen</b>(<i>on</i>) | |
| 782 | |
| 783 <p> | |
| 784 Private slot to toggle the full screen mode. | |
| 785 </p> | |
| 786 <dl> | |
| 787 | |
| 788 <dt><i>on</i> (bool)</dt> | |
| 789 <dd> | |
| 790 flag indicating to activate full screen mode | |
| 791 </dd> | |
| 792 </dl> | |
| 793 <a NAME="PdfViewerWindow.__toggleOpenRecentNew" ID="PdfViewerWindow.__toggleOpenRecentNew"></a> | |
| 794 <h4>PdfViewerWindow.__toggleOpenRecentNew</h4> | |
| 795 <b>__toggleOpenRecentNew</b>(<i>on</i>) | |
| 796 | |
| 797 <p> | |
| 798 Private slot to toggle the 'Open Recent File in New Window' action. | |
| 799 </p> | |
| 800 <dl> | |
| 801 | |
| 802 <dt><i>on</i> (bool)</dt> | |
| 803 <dd> | |
| 804 desired state of the action | |
| 805 </dd> | |
| 806 </dl> | |
| 807 <a NAME="PdfViewerWindow.__toggleSideBar" ID="PdfViewerWindow.__toggleSideBar"></a> | |
| 808 <h4>PdfViewerWindow.__toggleSideBar</h4> | |
| 809 <b>__toggleSideBar</b>(<i>visible</i>) | |
| 810 | |
| 811 <p> | |
| 812 Private slot to togle the sidebar (info) widget. | |
| 813 </p> | |
| 814 <dl> | |
| 815 | |
| 816 <dt><i>visible</i> (bool)</dt> | |
| 817 <dd> | |
| 818 desired state of the sidebar | |
| 819 </dd> | |
| 820 </dl> | |
| 821 <a NAME="PdfViewerWindow.__whatsThis" ID="PdfViewerWindow.__whatsThis"></a> | |
| 822 <h4>PdfViewerWindow.__whatsThis</h4> | |
| 823 <b>__whatsThis</b>(<i></i>) | |
| 824 | |
| 825 <p> | |
| 826 Private slot called in to enter Whats This mode. | |
| 827 </p> | |
| 828 <a NAME="PdfViewerWindow.__zoomIn" ID="PdfViewerWindow.__zoomIn"></a> | |
| 829 <h4>PdfViewerWindow.__zoomIn</h4> | |
| 830 <b>__zoomIn</b>(<i></i>) | |
| 831 | |
| 832 <p> | |
| 833 Private slot to zoom into the view. | |
| 834 </p> | |
| 835 <a NAME="PdfViewerWindow.__zoomModeChanged" ID="PdfViewerWindow.__zoomModeChanged"></a> | |
| 836 <h4>PdfViewerWindow.__zoomModeChanged</h4> | |
| 837 <b>__zoomModeChanged</b>(<i>zoomMode</i>) | |
| 838 | |
| 839 <p> | |
| 840 Private slot to handle a change of the zoom mode. | |
| 841 </p> | |
| 842 <dl> | |
| 843 | |
| 844 <dt><i>zoomMode</i> (QPdfView.ZoomMode)</dt> | |
| 845 <dd> | |
| 846 new zoom mode | |
| 847 </dd> | |
| 848 </dl> | |
| 849 <a NAME="PdfViewerWindow.__zoomOut" ID="PdfViewerWindow.__zoomOut"></a> | |
| 850 <h4>PdfViewerWindow.__zoomOut</h4> | |
| 851 <b>__zoomOut</b>(<i></i>) | |
| 852 | |
| 853 <p> | |
| 854 Private slot to zoom out of the view. | |
| 855 </p> | |
| 856 <a NAME="PdfViewerWindow.__zoomPageWidth" ID="PdfViewerWindow.__zoomPageWidth"></a> | |
| 857 <h4>PdfViewerWindow.__zoomPageWidth</h4> | |
| 858 <b>__zoomPageWidth</b>(<i>checked</i>) | |
| 859 | |
| 860 <p> | |
| 861 Private slot to fit the page width. | |
| 862 </p> | |
| 863 <dl> | |
| 864 | |
| 865 <dt><i>checked</i> (bool)</dt> | |
| 866 <dd> | |
| 867 flag indicating the check state | |
| 868 </dd> | |
| 869 </dl> | |
| 870 <a NAME="PdfViewerWindow.__zoomReset" ID="PdfViewerWindow.__zoomReset"></a> | |
| 871 <h4>PdfViewerWindow.__zoomReset</h4> | |
| 872 <b>__zoomReset</b>(<i></i>) | |
| 873 | |
| 874 <p> | |
| 875 Private slot to reset the zoom factor of the view. | |
| 876 </p> | |
| 877 <a NAME="PdfViewerWindow.__zoomWholePage" ID="PdfViewerWindow.__zoomWholePage"></a> | |
| 878 <h4>PdfViewerWindow.__zoomWholePage</h4> | |
| 879 <b>__zoomWholePage</b>(<i>checked</i>) | |
| 880 | |
| 881 <p> | |
| 882 Private slot to fit the page width. | |
| 883 </p> | |
| 884 <dl> | |
| 885 | |
| 886 <dt><i>checked</i> (bool)</dt> | |
| 887 <dd> | |
| 888 flag indicating the check state | |
| 889 </dd> | |
| 890 </dl> | |
| 891 <a NAME="PdfViewerWindow.closeEvent" ID="PdfViewerWindow.closeEvent"></a> | |
| 892 <h4>PdfViewerWindow.closeEvent</h4> | |
| 893 <b>closeEvent</b>(<i>evt</i>) | |
| 894 | |
| 895 <p> | |
| 896 Protected method handling the close event. | |
| 897 </p> | |
| 898 <dl> | |
| 899 | |
| 900 <dt><i>evt</i> (QCloseEvent)</dt> | |
| 901 <dd> | |
| 902 reference to the close event | |
| 903 </dd> | |
| 904 </dl> | |
| 905 <div align="right"><a href="#top">Up</a></div> | |
| 906 <hr /> | |
| 907 </body></html> |
