Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html

src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.HelpViewer.HelpViewerImplQTB</h1> 9 <h1>eric7.HelpViewer.HelpViewerImplQTB</h1>
10
11 <p> 10 <p>
12 Module implementing the QTextBrowser based help viewer class. 11 Module implementing the QTextBrowser based help viewer class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>AboutBlank</td></tr><tr><td>PageNotFound</td></tr> 16 <tr><td>AboutBlank</td></tr>
17 <tr><td>PageNotFound</td></tr>
18 </table> 18 </table>
19
19 <h3>Classes</h3> 20 <h3>Classes</h3>
20
21 <table> 21 <table>
22
23 <tr> 22 <tr>
24 <td><a href="#HelpViewerImplQTB">HelpViewerImplQTB</a></td> 23 <td><a href="#HelpViewerImplQTB">HelpViewerImplQTB</a></td>
25 <td>Class implementing the QTextBrowser based help viewer class.</td> 24 <td>Class implementing the QTextBrowser based help viewer class.</td>
26 </tr> 25 </tr>
27 </table> 26 </table>
27
28 <h3>Functions</h3> 28 <h3>Functions</h3>
29
30 <table> 29 <table>
31 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
32 </table> 31 </table>
32
33 <hr /> 33 <hr />
34 <hr /> 34 <hr />
35 <a NAME="HelpViewerImplQTB" ID="HelpViewerImplQTB"></a> 35 <a NAME="HelpViewerImplQTB" ID="HelpViewerImplQTB"></a>
36 <h2>HelpViewerImplQTB</h2> 36 <h2>HelpViewerImplQTB</h2>
37
38 <p> 37 <p>
39 Class implementing the QTextBrowser based help viewer class. 38 Class implementing the QTextBrowser based help viewer class.
40 </p> 39 </p>
40
41 <h3>Derived from</h3> 41 <h3>Derived from</h3>
42 HelpViewerImpl, QTextBrowser 42 HelpViewerImpl, QTextBrowser
43 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
44
45 <table> 44 <table>
46 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
47 </table> 46 </table>
47
48 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
49
50 <table> 49 <table>
51 <tr><td>None</td></tr> 50 <tr><td>None</td></tr>
52 </table> 51 </table>
52
53 <h3>Methods</h3> 53 <h3>Methods</h3>
54
55 <table> 54 <table>
56
57 <tr> 55 <tr>
58 <td><a href="#HelpViewerImplQTB.__init__">HelpViewerImplQTB</a></td> 56 <td><a href="#HelpViewerImplQTB.__init__">HelpViewerImplQTB</a></td>
59 <td>Constructor</td> 57 <td>Constructor</td>
60 </tr> 58 </tr>
61 <tr> 59 <tr>
181 <tr> 179 <tr>
182 <td><a href="#HelpViewerImplQTB.wheelEvent">wheelEvent</a></td> 180 <td><a href="#HelpViewerImplQTB.wheelEvent">wheelEvent</a></td>
183 <td>Protected method to handle wheel event to zoom.</td> 181 <td>Protected method to handle wheel event to zoom.</td>
184 </tr> 182 </tr>
185 </table> 183 </table>
184
186 <h3>Static Methods</h3> 185 <h3>Static Methods</h3>
187
188 <table> 186 <table>
189 <tr><td>None</td></tr> 187 <tr><td>None</td></tr>
190 </table> 188 </table>
191 189
190
192 <a NAME="HelpViewerImplQTB.__init__" ID="HelpViewerImplQTB.__init__"></a> 191 <a NAME="HelpViewerImplQTB.__init__" ID="HelpViewerImplQTB.__init__"></a>
193 <h4>HelpViewerImplQTB (Constructor)</h4> 192 <h4>HelpViewerImplQTB (Constructor)</h4>
194 <b>HelpViewerImplQTB</b>(<i>engine, parent=None</i>) 193 <b>HelpViewerImplQTB</b>(<i>engine, parent=None</i>)
195
196 <p> 194 <p>
197 Constructor 195 Constructor
198 </p> 196 </p>
197
199 <dl> 198 <dl>
200 199
201 <dt><i>engine</i> (QHelpEngine)</dt> 200 <dt><i>engine</i> (QHelpEngine)</dt>
202 <dd> 201 <dd>
203 reference to the help engine 202 reference to the help engine
208 </dd> 207 </dd>
209 </dl> 208 </dl>
210 <a NAME="HelpViewerImplQTB.__bookmarkPage" ID="HelpViewerImplQTB.__bookmarkPage"></a> 209 <a NAME="HelpViewerImplQTB.__bookmarkPage" ID="HelpViewerImplQTB.__bookmarkPage"></a>
211 <h4>HelpViewerImplQTB.__bookmarkPage</h4> 210 <h4>HelpViewerImplQTB.__bookmarkPage</h4>
212 <b>__bookmarkPage</b>(<i>act</i>) 211 <b>__bookmarkPage</b>(<i>act</i>)
213
214 <p> 212 <p>
215 Private method called by the context menu to bookmark the page. 213 Private method called by the context menu to bookmark the page.
216 </p> 214 </p>
215
217 <dl> 216 <dl>
218 217
219 <dt><i>act</i> (QAction)</dt> 218 <dt><i>act</i> (QAction)</dt>
220 <dd> 219 <dd>
221 reference to the action that triggered 220 reference to the action that triggered
222 </dd> 221 </dd>
223 </dl> 222 </dl>
224 <a NAME="HelpViewerImplQTB.__canLoadResource" ID="HelpViewerImplQTB.__canLoadResource"></a> 223 <a NAME="HelpViewerImplQTB.__canLoadResource" ID="HelpViewerImplQTB.__canLoadResource"></a>
225 <h4>HelpViewerImplQTB.__canLoadResource</h4> 224 <h4>HelpViewerImplQTB.__canLoadResource</h4>
226 <b>__canLoadResource</b>(<i>url</i>) 225 <b>__canLoadResource</b>(<i>url</i>)
227
228 <p> 226 <p>
229 Private method to check, if the given resource can be loaded. 227 Private method to check, if the given resource can be loaded.
230 </p> 228 </p>
229
231 <dl> 230 <dl>
232 231
233 <dt><i>url</i> (QUrl)</dt> 232 <dt><i>url</i> (QUrl)</dt>
234 <dd> 233 <dd>
235 URL of resource to be loaded 234 URL of resource to be loaded
248 </dd> 247 </dd>
249 </dl> 248 </dl>
250 <a NAME="HelpViewerImplQTB.__closeOtherPages" ID="HelpViewerImplQTB.__closeOtherPages"></a> 249 <a NAME="HelpViewerImplQTB.__closeOtherPages" ID="HelpViewerImplQTB.__closeOtherPages"></a>
251 <h4>HelpViewerImplQTB.__closeOtherPages</h4> 250 <h4>HelpViewerImplQTB.__closeOtherPages</h4>
252 <b>__closeOtherPages</b>(<i></i>) 251 <b>__closeOtherPages</b>(<i></i>)
253
254 <p> 252 <p>
255 Private method called by the context menu to close all other pages. 253 Private method called by the context menu to close all other pages.
256 </p> 254 </p>
255
257 <a NAME="HelpViewerImplQTB.__closePage" ID="HelpViewerImplQTB.__closePage"></a> 256 <a NAME="HelpViewerImplQTB.__closePage" ID="HelpViewerImplQTB.__closePage"></a>
258 <h4>HelpViewerImplQTB.__closePage</h4> 257 <h4>HelpViewerImplQTB.__closePage</h4>
259 <b>__closePage</b>(<i></i>) 258 <b>__closePage</b>(<i></i>)
260
261 <p> 259 <p>
262 Private method called by the context menu to close the current page. 260 Private method called by the context menu to close the current page.
263 </p> 261 </p>
262
264 <a NAME="HelpViewerImplQTB.__copyLink" ID="HelpViewerImplQTB.__copyLink"></a> 263 <a NAME="HelpViewerImplQTB.__copyLink" ID="HelpViewerImplQTB.__copyLink"></a>
265 <h4>HelpViewerImplQTB.__copyLink</h4> 264 <h4>HelpViewerImplQTB.__copyLink</h4>
266 <b>__copyLink</b>(<i>act</i>) 265 <b>__copyLink</b>(<i>act</i>)
267
268 <p> 266 <p>
269 Private method called by the context menu to copy a link to the 267 Private method called by the context menu to copy a link to the
270 clipboard. 268 clipboard.
271 </p> 269 </p>
270
272 <dl> 271 <dl>
273 272
274 <dt><i>act</i> (QAction)</dt> 273 <dt><i>act</i> (QAction)</dt>
275 <dd> 274 <dd>
276 reference to the action that triggered 275 reference to the action that triggered
277 </dd> 276 </dd>
278 </dl> 277 </dl>
279 <a NAME="HelpViewerImplQTB.__createLinkContextMenu" ID="HelpViewerImplQTB.__createLinkContextMenu"></a> 278 <a NAME="HelpViewerImplQTB.__createLinkContextMenu" ID="HelpViewerImplQTB.__createLinkContextMenu"></a>
280 <h4>HelpViewerImplQTB.__createLinkContextMenu</h4> 279 <h4>HelpViewerImplQTB.__createLinkContextMenu</h4>
281 <b>__createLinkContextMenu</b>(<i>menu, linkUrl</i>) 280 <b>__createLinkContextMenu</b>(<i>menu, linkUrl</i>)
282
283 <p> 281 <p>
284 Private method to populate the context menu for URLs. 282 Private method to populate the context menu for URLs.
285 </p> 283 </p>
284
286 <dl> 285 <dl>
287 286
288 <dt><i>menu</i> (QMenu)</dt> 287 <dt><i>menu</i> (QMenu)</dt>
289 <dd> 288 <dd>
290 reference to the menu to be populated 289 reference to the menu to be populated
295 </dd> 294 </dd>
296 </dl> 295 </dl>
297 <a NAME="HelpViewerImplQTB.__openLinkInBackgroundPage" ID="HelpViewerImplQTB.__openLinkInBackgroundPage"></a> 296 <a NAME="HelpViewerImplQTB.__openLinkInBackgroundPage" ID="HelpViewerImplQTB.__openLinkInBackgroundPage"></a>
298 <h4>HelpViewerImplQTB.__openLinkInBackgroundPage</h4> 297 <h4>HelpViewerImplQTB.__openLinkInBackgroundPage</h4>
299 <b>__openLinkInBackgroundPage</b>(<i>act</i>) 298 <b>__openLinkInBackgroundPage</b>(<i>act</i>)
300
301 <p> 299 <p>
302 Private method called by the context menu to open a link in a 300 Private method called by the context menu to open a link in a
303 background page. 301 background page.
304 </p> 302 </p>
303
305 <dl> 304 <dl>
306 305
307 <dt><i>act</i> (QAction)</dt> 306 <dt><i>act</i> (QAction)</dt>
308 <dd> 307 <dd>
309 reference to the action that triggered 308 reference to the action that triggered
310 </dd> 309 </dd>
311 </dl> 310 </dl>
312 <a NAME="HelpViewerImplQTB.__openLinkInNewPage" ID="HelpViewerImplQTB.__openLinkInNewPage"></a> 311 <a NAME="HelpViewerImplQTB.__openLinkInNewPage" ID="HelpViewerImplQTB.__openLinkInNewPage"></a>
313 <h4>HelpViewerImplQTB.__openLinkInNewPage</h4> 312 <h4>HelpViewerImplQTB.__openLinkInNewPage</h4>
314 <b>__openLinkInNewPage</b>(<i>act</i>) 313 <b>__openLinkInNewPage</b>(<i>act</i>)
315
316 <p> 314 <p>
317 Private method called by the context menu to open a link in a new page. 315 Private method called by the context menu to open a link in a new page.
318 </p> 316 </p>
317
319 <dl> 318 <dl>
320 319
321 <dt><i>act</i> (QAction)</dt> 320 <dt><i>act</i> (QAction)</dt>
322 <dd> 321 <dd>
323 reference to the action that triggered 322 reference to the action that triggered
324 </dd> 323 </dd>
325 </dl> 324 </dl>
326 <a NAME="HelpViewerImplQTB.__showContextMenu" ID="HelpViewerImplQTB.__showContextMenu"></a> 325 <a NAME="HelpViewerImplQTB.__showContextMenu" ID="HelpViewerImplQTB.__showContextMenu"></a>
327 <h4>HelpViewerImplQTB.__showContextMenu</h4> 326 <h4>HelpViewerImplQTB.__showContextMenu</h4>
328 <b>__showContextMenu</b>(<i>pos</i>) 327 <b>__showContextMenu</b>(<i>pos</i>)
329
330 <p> 328 <p>
331 Private slot to show the context menu. 329 Private slot to show the context menu.
332 </p> 330 </p>
331
333 <dl> 332 <dl>
334 333
335 <dt><i>pos</i> (QPoint)</dt> 334 <dt><i>pos</i> (QPoint)</dt>
336 <dd> 335 <dd>
337 position to show the context menu at 336 position to show the context menu at
338 </dd> 337 </dd>
339 </dl> 338 </dl>
340 <a NAME="HelpViewerImplQTB.doSetSource" ID="HelpViewerImplQTB.doSetSource"></a> 339 <a NAME="HelpViewerImplQTB.doSetSource" ID="HelpViewerImplQTB.doSetSource"></a>
341 <h4>HelpViewerImplQTB.doSetSource</h4> 340 <h4>HelpViewerImplQTB.doSetSource</h4>
342 <b>doSetSource</b>(<i>url, type_</i>) 341 <b>doSetSource</b>(<i>url, type_</i>)
343
344 <p> 342 <p>
345 Public method to load the data and show it. 343 Public method to load the data and show it.
346 </p> 344 </p>
345
347 <dl> 346 <dl>
348 347
349 <dt><i>url</i> (QUrl)</dt> 348 <dt><i>url</i> (QUrl)</dt>
350 <dd> 349 <dd>
351 URL of resource to load 350 URL of resource to load
356 </dd> 355 </dd>
357 </dl> 356 </dl>
358 <a NAME="HelpViewerImplQTB.event" ID="HelpViewerImplQTB.event"></a> 357 <a NAME="HelpViewerImplQTB.event" ID="HelpViewerImplQTB.event"></a>
359 <h4>HelpViewerImplQTB.event</h4> 358 <h4>HelpViewerImplQTB.event</h4>
360 <b>event</b>(<i>evt</i>) 359 <b>event</b>(<i>evt</i>)
361
362 <p> 360 <p>
363 Public method handling events. 361 Public method handling events.
364 </p> 362 </p>
363
365 <dl> 364 <dl>
366 365
367 <dt><i>evt</i> (QEvent)</dt> 366 <dt><i>evt</i> (QEvent)</dt>
368 <dd> 367 <dd>
369 reference to the event 368 reference to the event
382 </dd> 381 </dd>
383 </dl> 382 </dl>
384 <a NAME="HelpViewerImplQTB.gestureEvent" ID="HelpViewerImplQTB.gestureEvent"></a> 383 <a NAME="HelpViewerImplQTB.gestureEvent" ID="HelpViewerImplQTB.gestureEvent"></a>
385 <h4>HelpViewerImplQTB.gestureEvent</h4> 384 <h4>HelpViewerImplQTB.gestureEvent</h4>
386 <b>gestureEvent</b>(<i>evt</i>) 385 <b>gestureEvent</b>(<i>evt</i>)
387
388 <p> 386 <p>
389 Protected method handling gesture events. 387 Protected method handling gesture events.
390 </p> 388 </p>
389
391 <dl> 390 <dl>
392 391
393 <dt><i>evt</i> (QGestureEvent)</dt> 392 <dt><i>evt</i> (QGestureEvent)</dt>
394 <dd> 393 <dd>
395 reference to the gesture event 394 reference to the gesture event
396 </dd> 395 </dd>
397 </dl> 396 </dl>
398 <a NAME="HelpViewerImplQTB.gotoHistory" ID="HelpViewerImplQTB.gotoHistory"></a> 397 <a NAME="HelpViewerImplQTB.gotoHistory" ID="HelpViewerImplQTB.gotoHistory"></a>
399 <h4>HelpViewerImplQTB.gotoHistory</h4> 398 <h4>HelpViewerImplQTB.gotoHistory</h4>
400 <b>gotoHistory</b>(<i>index</i>) 399 <b>gotoHistory</b>(<i>index</i>)
401
402 <p> 400 <p>
403 Public method to step through the history. 401 Public method to step through the history.
404 </p> 402 </p>
403
405 <dl> 404 <dl>
406 405
407 <dt><i>index</i> (int)</dt> 406 <dt><i>index</i> (int)</dt>
408 <dd> 407 <dd>
409 history index (<0 backward, >0 forward) 408 history index (<0 backward, >0 forward)
410 </dd> 409 </dd>
411 </dl> 410 </dl>
412 <a NAME="HelpViewerImplQTB.isBackwardAvailable" ID="HelpViewerImplQTB.isBackwardAvailable"></a> 411 <a NAME="HelpViewerImplQTB.isBackwardAvailable" ID="HelpViewerImplQTB.isBackwardAvailable"></a>
413 <h4>HelpViewerImplQTB.isBackwardAvailable</h4> 412 <h4>HelpViewerImplQTB.isBackwardAvailable</h4>
414 <b>isBackwardAvailable</b>(<i></i>) 413 <b>isBackwardAvailable</b>(<i></i>)
415
416 <p> 414 <p>
417 Public method to check, if stepping backward through the history is 415 Public method to check, if stepping backward through the history is
418 available. 416 available.
419 </p> 417 </p>
418
420 <dl> 419 <dl>
421 <dt>Return:</dt> 420 <dt>Return:</dt>
422 <dd> 421 <dd>
423 flag indicating backward stepping is available 422 flag indicating backward stepping is available
424 </dd> 423 </dd>
430 </dd> 429 </dd>
431 </dl> 430 </dl>
432 <a NAME="HelpViewerImplQTB.isEmptyPage" ID="HelpViewerImplQTB.isEmptyPage"></a> 431 <a NAME="HelpViewerImplQTB.isEmptyPage" ID="HelpViewerImplQTB.isEmptyPage"></a>
433 <h4>HelpViewerImplQTB.isEmptyPage</h4> 432 <h4>HelpViewerImplQTB.isEmptyPage</h4>
434 <b>isEmptyPage</b>(<i></i>) 433 <b>isEmptyPage</b>(<i></i>)
435
436 <p> 434 <p>
437 Public method to check, if the current page is the empty page. 435 Public method to check, if the current page is the empty page.
438 </p> 436 </p>
437
439 <dl> 438 <dl>
440 <dt>Return:</dt> 439 <dt>Return:</dt>
441 <dd> 440 <dd>
442 flag indicating an empty page is loaded 441 flag indicating an empty page is loaded
443 </dd> 442 </dd>
449 </dd> 448 </dd>
450 </dl> 449 </dl>
451 <a NAME="HelpViewerImplQTB.isForwardAvailable" ID="HelpViewerImplQTB.isForwardAvailable"></a> 450 <a NAME="HelpViewerImplQTB.isForwardAvailable" ID="HelpViewerImplQTB.isForwardAvailable"></a>
452 <h4>HelpViewerImplQTB.isForwardAvailable</h4> 451 <h4>HelpViewerImplQTB.isForwardAvailable</h4>
453 <b>isForwardAvailable</b>(<i></i>) 452 <b>isForwardAvailable</b>(<i></i>)
454
455 <p> 453 <p>
456 Public method to check, if stepping forward through the history is 454 Public method to check, if stepping forward through the history is
457 available. 455 available.
458 </p> 456 </p>
457
459 <dl> 458 <dl>
460 <dt>Return:</dt> 459 <dt>Return:</dt>
461 <dd> 460 <dd>
462 flag indicating forward stepping is available 461 flag indicating forward stepping is available
463 </dd> 462 </dd>
469 </dd> 468 </dd>
470 </dl> 469 </dl>
471 <a NAME="HelpViewerImplQTB.isScaleDownAvailable" ID="HelpViewerImplQTB.isScaleDownAvailable"></a> 470 <a NAME="HelpViewerImplQTB.isScaleDownAvailable" ID="HelpViewerImplQTB.isScaleDownAvailable"></a>
472 <h4>HelpViewerImplQTB.isScaleDownAvailable</h4> 471 <h4>HelpViewerImplQTB.isScaleDownAvailable</h4>
473 <b>isScaleDownAvailable</b>(<i></i>) 472 <b>isScaleDownAvailable</b>(<i></i>)
474
475 <p> 473 <p>
476 Public method to check, if the min. zoom level is reached. 474 Public method to check, if the min. zoom level is reached.
477 </p> 475 </p>
476
478 <dl> 477 <dl>
479 <dt>Return:</dt> 478 <dt>Return:</dt>
480 <dd> 479 <dd>
481 flag indicating scale down is available 480 flag indicating scale down is available
482 </dd> 481 </dd>
488 </dd> 487 </dd>
489 </dl> 488 </dl>
490 <a NAME="HelpViewerImplQTB.isScaleUpAvailable" ID="HelpViewerImplQTB.isScaleUpAvailable"></a> 489 <a NAME="HelpViewerImplQTB.isScaleUpAvailable" ID="HelpViewerImplQTB.isScaleUpAvailable"></a>
491 <h4>HelpViewerImplQTB.isScaleUpAvailable</h4> 490 <h4>HelpViewerImplQTB.isScaleUpAvailable</h4>
492 <b>isScaleUpAvailable</b>(<i></i>) 491 <b>isScaleUpAvailable</b>(<i></i>)
493
494 <p> 492 <p>
495 Public method to check, if the max. zoom level is reached. 493 Public method to check, if the max. zoom level is reached.
496 </p> 494 </p>
495
497 <dl> 496 <dl>
498 <dt>Return:</dt> 497 <dt>Return:</dt>
499 <dd> 498 <dd>
500 flag indicating scale up is available 499 flag indicating scale up is available
501 </dd> 500 </dd>
507 </dd> 506 </dd>
508 </dl> 507 </dl>
509 <a NAME="HelpViewerImplQTB.keyPressEvent" ID="HelpViewerImplQTB.keyPressEvent"></a> 508 <a NAME="HelpViewerImplQTB.keyPressEvent" ID="HelpViewerImplQTB.keyPressEvent"></a>
510 <h4>HelpViewerImplQTB.keyPressEvent</h4> 509 <h4>HelpViewerImplQTB.keyPressEvent</h4>
511 <b>keyPressEvent</b>(<i>evt</i>) 510 <b>keyPressEvent</b>(<i>evt</i>)
512
513 <p> 511 <p>
514 Protected method to handle key press events. 512 Protected method to handle key press events.
515 </p> 513 </p>
514
516 <dl> 515 <dl>
517 516
518 <dt><i>evt</i> (QKeyEvent)</dt> 517 <dt><i>evt</i> (QKeyEvent)</dt>
519 <dd> 518 <dd>
520 reference to the key event 519 reference to the key event
521 </dd> 520 </dd>
522 </dl> 521 </dl>
523 <a NAME="HelpViewerImplQTB.link" ID="HelpViewerImplQTB.link"></a> 522 <a NAME="HelpViewerImplQTB.link" ID="HelpViewerImplQTB.link"></a>
524 <h4>HelpViewerImplQTB.link</h4> 523 <h4>HelpViewerImplQTB.link</h4>
525 <b>link</b>(<i></i>) 524 <b>link</b>(<i></i>)
526
527 <p> 525 <p>
528 Public method to get the URL of the shown document. 526 Public method to get the URL of the shown document.
529 </p> 527 </p>
528
530 <dl> 529 <dl>
531 <dt>Return:</dt> 530 <dt>Return:</dt>
532 <dd> 531 <dd>
533 URL of the document 532 URL of the document
534 </dd> 533 </dd>
540 </dd> 539 </dd>
541 </dl> 540 </dl>
542 <a NAME="HelpViewerImplQTB.loadResource" ID="HelpViewerImplQTB.loadResource"></a> 541 <a NAME="HelpViewerImplQTB.loadResource" ID="HelpViewerImplQTB.loadResource"></a>
543 <h4>HelpViewerImplQTB.loadResource</h4> 542 <h4>HelpViewerImplQTB.loadResource</h4>
544 <b>loadResource</b>(<i>type_, name</i>) 543 <b>loadResource</b>(<i>type_, name</i>)
545
546 <p> 544 <p>
547 Public method to load data of the specified type from the resource with 545 Public method to load data of the specified type from the resource with
548 the given name. 546 the given name.
549 </p> 547 </p>
548
550 <dl> 549 <dl>
551 550
552 <dt><i>type_</i> (int)</dt> 551 <dt><i>type_</i> (int)</dt>
553 <dd> 552 <dd>
554 resource type 553 resource type
571 </dd> 570 </dd>
572 </dl> 571 </dl>
573 <a NAME="HelpViewerImplQTB.mousePressEvent" ID="HelpViewerImplQTB.mousePressEvent"></a> 572 <a NAME="HelpViewerImplQTB.mousePressEvent" ID="HelpViewerImplQTB.mousePressEvent"></a>
574 <h4>HelpViewerImplQTB.mousePressEvent</h4> 573 <h4>HelpViewerImplQTB.mousePressEvent</h4>
575 <b>mousePressEvent</b>(<i>evt</i>) 574 <b>mousePressEvent</b>(<i>evt</i>)
576
577 <p> 575 <p>
578 Protected method called by a mouse press event. 576 Protected method called by a mouse press event.
579 </p> 577 </p>
578
580 <dl> 579 <dl>
581 580
582 <dt><i>evt</i> (QMouseEvent)</dt> 581 <dt><i>evt</i> (QMouseEvent)</dt>
583 <dd> 582 <dd>
584 reference to the mouse event 583 reference to the mouse event
585 </dd> 584 </dd>
586 </dl> 585 </dl>
587 <a NAME="HelpViewerImplQTB.mouseReleaseEvent" ID="HelpViewerImplQTB.mouseReleaseEvent"></a> 586 <a NAME="HelpViewerImplQTB.mouseReleaseEvent" ID="HelpViewerImplQTB.mouseReleaseEvent"></a>
588 <h4>HelpViewerImplQTB.mouseReleaseEvent</h4> 587 <h4>HelpViewerImplQTB.mouseReleaseEvent</h4>
589 <b>mouseReleaseEvent</b>(<i>evt</i>) 588 <b>mouseReleaseEvent</b>(<i>evt</i>)
590
591 <p> 589 <p>
592 Protected method called by a mouse release event. 590 Protected method called by a mouse release event.
593 </p> 591 </p>
592
594 <dl> 593 <dl>
595 594
596 <dt><i>evt</i> (QMouseEvent)</dt> 595 <dt><i>evt</i> (QMouseEvent)</dt>
597 <dd> 596 <dd>
598 reference to the mouse event 597 reference to the mouse event
599 </dd> 598 </dd>
600 </dl> 599 </dl>
601 <a NAME="HelpViewerImplQTB.pageTitle" ID="HelpViewerImplQTB.pageTitle"></a> 600 <a NAME="HelpViewerImplQTB.pageTitle" ID="HelpViewerImplQTB.pageTitle"></a>
602 <h4>HelpViewerImplQTB.pageTitle</h4> 601 <h4>HelpViewerImplQTB.pageTitle</h4>
603 <b>pageTitle</b>(<i></i>) 602 <b>pageTitle</b>(<i></i>)
604
605 <p> 603 <p>
606 Public method get the page title. 604 Public method get the page title.
607 </p> 605 </p>
606
608 <dl> 607 <dl>
609 <dt>Return:</dt> 608 <dt>Return:</dt>
610 <dd> 609 <dd>
611 page title 610 page title
612 </dd> 611 </dd>
618 </dd> 617 </dd>
619 </dl> 618 </dl>
620 <a NAME="HelpViewerImplQTB.resetScale" ID="HelpViewerImplQTB.resetScale"></a> 619 <a NAME="HelpViewerImplQTB.resetScale" ID="HelpViewerImplQTB.resetScale"></a>
621 <h4>HelpViewerImplQTB.resetScale</h4> 620 <h4>HelpViewerImplQTB.resetScale</h4>
622 <b>resetScale</b>(<i></i>) 621 <b>resetScale</b>(<i></i>)
623
624 <p> 622 <p>
625 Public method to reset the zoom level. 623 Public method to reset the zoom level.
626 </p> 624 </p>
625
627 <a NAME="HelpViewerImplQTB.scale" ID="HelpViewerImplQTB.scale"></a> 626 <a NAME="HelpViewerImplQTB.scale" ID="HelpViewerImplQTB.scale"></a>
628 <h4>HelpViewerImplQTB.scale</h4> 627 <h4>HelpViewerImplQTB.scale</h4>
629 <b>scale</b>(<i></i>) 628 <b>scale</b>(<i></i>)
630
631 <p> 629 <p>
632 Public method to get the zoom level. 630 Public method to get the zoom level.
633 </p> 631 </p>
632
634 <dl> 633 <dl>
635 <dt>Return:</dt> 634 <dt>Return:</dt>
636 <dd> 635 <dd>
637 current zoom level 636 current zoom level
638 </dd> 637 </dd>
644 </dd> 643 </dd>
645 </dl> 644 </dl>
646 <a NAME="HelpViewerImplQTB.scaleDown" ID="HelpViewerImplQTB.scaleDown"></a> 645 <a NAME="HelpViewerImplQTB.scaleDown" ID="HelpViewerImplQTB.scaleDown"></a>
647 <h4>HelpViewerImplQTB.scaleDown</h4> 646 <h4>HelpViewerImplQTB.scaleDown</h4>
648 <b>scaleDown</b>(<i></i>) 647 <b>scaleDown</b>(<i></i>)
649
650 <p> 648 <p>
651 Public method to zoom out. 649 Public method to zoom out.
652 </p> 650 </p>
651
653 <a NAME="HelpViewerImplQTB.scaleUp" ID="HelpViewerImplQTB.scaleUp"></a> 652 <a NAME="HelpViewerImplQTB.scaleUp" ID="HelpViewerImplQTB.scaleUp"></a>
654 <h4>HelpViewerImplQTB.scaleUp</h4> 653 <h4>HelpViewerImplQTB.scaleUp</h4>
655 <b>scaleUp</b>(<i></i>) 654 <b>scaleUp</b>(<i></i>)
656
657 <p> 655 <p>
658 Public method to zoom in. 656 Public method to zoom in.
659 </p> 657 </p>
658
660 <a NAME="HelpViewerImplQTB.setLink" ID="HelpViewerImplQTB.setLink"></a> 659 <a NAME="HelpViewerImplQTB.setLink" ID="HelpViewerImplQTB.setLink"></a>
661 <h4>HelpViewerImplQTB.setLink</h4> 660 <h4>HelpViewerImplQTB.setLink</h4>
662 <b>setLink</b>(<i>url</i>) 661 <b>setLink</b>(<i>url</i>)
663
664 <p> 662 <p>
665 Public method to set the URL of the document to be shown. 663 Public method to set the URL of the document to be shown.
666 </p> 664 </p>
665
667 <dl> 666 <dl>
668 667
669 <dt><i>url</i> (QUrl)</dt> 668 <dt><i>url</i> (QUrl)</dt>
670 <dd> 669 <dd>
671 source of the document 670 source of the document
672 </dd> 671 </dd>
673 </dl> 672 </dl>
674 <a NAME="HelpViewerImplQTB.setScale" ID="HelpViewerImplQTB.setScale"></a> 673 <a NAME="HelpViewerImplQTB.setScale" ID="HelpViewerImplQTB.setScale"></a>
675 <h4>HelpViewerImplQTB.setScale</h4> 674 <h4>HelpViewerImplQTB.setScale</h4>
676 <b>setScale</b>(<i>scale</i>) 675 <b>setScale</b>(<i>scale</i>)
677
678 <p> 676 <p>
679 Public method to set the zoom level. 677 Public method to set the zoom level.
680 </p> 678 </p>
679
681 <dl> 680 <dl>
682 681
683 <dt><i>scale</i> (int)</dt> 682 <dt><i>scale</i> (int)</dt>
684 <dd> 683 <dd>
685 zoom level to set 684 zoom level to set
686 </dd> 685 </dd>
687 </dl> 686 </dl>
688 <a NAME="HelpViewerImplQTB.wheelEvent" ID="HelpViewerImplQTB.wheelEvent"></a> 687 <a NAME="HelpViewerImplQTB.wheelEvent" ID="HelpViewerImplQTB.wheelEvent"></a>
689 <h4>HelpViewerImplQTB.wheelEvent</h4> 688 <h4>HelpViewerImplQTB.wheelEvent</h4>
690 <b>wheelEvent</b>(<i>evt</i>) 689 <b>wheelEvent</b>(<i>evt</i>)
691
692 <p> 690 <p>
693 Protected method to handle wheel event to zoom. 691 Protected method to handle wheel event to zoom.
694 </p> 692 </p>
693
695 <dl> 694 <dl>
696 695
697 <dt><i>evt</i> (QWheelEvent)</dt> 696 <dt><i>evt</i> (QWheelEvent)</dt>
698 <dd> 697 <dd>
699 reference to the event object 698 reference to the event object

Mercurial Repository: eric

eric ide

mercurial