| … | |
… | |
| 22 | |
22 | |
| 23 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
23 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
| 24 | thus must be encoded as UTF-8. |
24 | thus must be encoded as UTF-8. |
| 25 | |
25 | |
| 26 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
26 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
| 27 | scripts will be shared (But not enabled) for all terminals. |
27 | scripts will be shared (but not enabled) for all terminals. |
|
|
28 | |
|
|
29 | =head1 PACKAGED EXTENSIONS |
|
|
30 | |
|
|
31 | This section describes the extensiosn delivered with this version. You can |
|
|
32 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
|
|
33 | |
|
|
34 | You can activate them like this: |
|
|
35 | |
|
|
36 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
37 | |
|
|
38 | =over 4 |
|
|
39 | |
|
|
40 | =item selection |
|
|
41 | |
|
|
42 | Miscellaneous selection modifications. |
|
|
43 | |
|
|
44 | =over 4 |
|
|
45 | |
|
|
46 | =item rot13 |
|
|
47 | |
|
|
48 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
49 | |
|
|
50 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
51 | |
|
|
52 | =back |
|
|
53 | |
|
|
54 | =item digital-clock |
|
|
55 | |
|
|
56 | Displays a very simple digital clock in the upper right corner of the |
|
|
57 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
58 | overlays or changes. |
|
|
59 | |
|
|
60 | =item simple-overlay-clock |
|
|
61 | |
|
|
62 | Displays a digital clock using the built-in overlay (colorful, useless). |
|
|
63 | |
|
|
64 | =back |
| 28 | |
65 | |
| 29 | =head2 General API Considerations |
66 | =head2 General API Considerations |
| 30 | |
67 | |
| 31 | All objects (such as terminals, time watchers etc.) are typical |
68 | All objects (such as terminals, time watchers etc.) are typical |
| 32 | reference-to-hash objects. The hash can be used to store anything you |
69 | reference-to-hash objects. The hash can be used to store anything you |
| … | |
… | |
| 390 | Convert the given locale-encoded octets into a perl string. |
427 | Convert the given locale-encoded octets into a perl string. |
| 391 | |
428 | |
| 392 | =item $term->tt_write ($octets) |
429 | =item $term->tt_write ($octets) |
| 393 | |
430 | |
| 394 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
431 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
| 395 | pass characters instead of octets, you should convetr you strings first to |
432 | pass characters instead of octets, you should convert your strings first |
| 396 | the locale-specific encoding using C<< $term->locale_encode >>. |
433 | to the locale-specific encoding using C<< $term->locale_encode >>. |
| 397 | |
434 | |
|
|
435 | =item $nrow = $term->nrow |
|
|
436 | |
|
|
437 | =item $ncol = $term->ncol |
|
|
438 | |
|
|
439 | Return the number of rows/columns of the terminal window (i.e. as |
|
|
440 | specified by C<-geometry>, excluding any scrollback). |
|
|
441 | |
|
|
442 | =item $nsaved = $term->nsaved |
|
|
443 | |
|
|
444 | Returns the number of lines in the scrollback buffer. |
|
|
445 | |
|
|
446 | =item $view_start = $term->view_start ([$newvalue]) |
|
|
447 | |
|
|
448 | Returns the negative row number of the topmost line. Minimum value is |
|
|
449 | C<0>, which displays the normal terminal contents. Larger values scroll |
|
|
450 | this many lines into the scrollback buffer. |
|
|
451 | |
|
|
452 | =item $term->want_refresh |
|
|
453 | |
|
|
454 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
455 | compare the on-screen display with its stored representation. If they |
|
|
456 | differ, it redraws the differences. |
|
|
457 | |
|
|
458 | Used after changing terminal contents to display them. |
|
|
459 | |
|
|
460 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
|
|
461 | |
|
|
462 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
|
|
463 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
|
|
464 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
465 | line C<< -$term->nsaved >>. |
|
|
466 | |
|
|
467 | If C<$new_text> is specified, it will replace characters in the current |
|
|
468 | line, starting at column C<$start_col> (default C<0>), which is useful |
|
|
469 | to replace only parts of a line. The font iindex in the rendition will |
|
|
470 | automatically be updated. |
|
|
471 | |
|
|
472 | C<$text> is in a special encoding: tabs and wide characters that use more |
|
|
473 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
474 | (C<chr 65535>). Characters with combining characters and other characters |
|
|
475 | that do not fit into the normal tetx encoding will be replaced with |
|
|
476 | characters in the private use area. |
|
|
477 | |
|
|
478 | You have to obey this encoding when changing text. The advantage is |
|
|
479 | that C<substr> and similar functions work on screen cells and not on |
|
|
480 | characters. |
|
|
481 | |
|
|
482 | The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
|
|
483 | can be used to convert normal strings into this encoding and vice versa. |
|
|
484 | |
|
|
485 | =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
|
|
486 | |
|
|
487 | Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
|
|
488 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
489 | styles and similar information. See also C<< $term->ROW_t >>. |
|
|
490 | |
|
|
491 | When setting rendition, the font mask will be ignored. |
|
|
492 | |
|
|
493 | See the section on RENDITION, below. |
|
|
494 | |
|
|
495 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
|
|
496 | |
|
|
497 | Returns the number of screen cells that are in use ("the line length"). If |
|
|
498 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
|
|
499 | means all characters are in use and it is continued on the next row. |
|
|
500 | |
|
|
501 | =item $text = $term->special_encode $string |
|
|
502 | |
|
|
503 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
504 | where one character corresponds to one screen cell. See |
|
|
505 | C<< $term->ROW_t >> for details. |
|
|
506 | |
|
|
507 | =item $string = $term->special_decode $text |
|
|
508 | |
|
|
509 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
510 | C<< $term->ROW_t >> for details. |
|
|
511 | |
| 398 | =back |
512 | =back |
|
|
513 | |
|
|
514 | =head2 RENDITION |
|
|
515 | |
|
|
516 | Rendition bitsets contain information about colour, font, font styles and |
|
|
517 | similar information for each screen cell. |
|
|
518 | |
|
|
519 | The following "macros" deal with changes in rendition sets. You should |
|
|
520 | never just create a bitset, you should always modify an existing one, |
|
|
521 | as they contain important information required for correct operation of |
|
|
522 | rxvt-unicode. |
|
|
523 | |
|
|
524 | =over 4 |
|
|
525 | |
|
|
526 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
527 | |
|
|
528 | Returns the default rendition, as used when the terminal is starting up or |
|
|
529 | being reset. Useful as a base |
|
|
530 | |
|
|
531 | =back |
|
|
532 | |
|
|
533 | =cut |
| 399 | |
534 | |
| 400 | =head2 The C<urxvt::timer> Class |
535 | =head2 The C<urxvt::timer> Class |
| 401 | |
536 | |
| 402 | This class implements timer watchers/events. Time is represented as a |
537 | This class implements timer watchers/events. Time is represented as a |
| 403 | fractional number of seconds since the epoch. Example: |
538 | fractional number of seconds since the epoch. Example: |
