| … | |
… | |
| 62 | |
62 | |
| 63 | Displays a digital clock using the built-in overlay. |
63 | Displays a digital clock using the built-in overlay. |
| 64 | |
64 | |
| 65 | =item mark-urls |
65 | =item mark-urls |
| 66 | |
66 | |
| 67 | Uses per-line filtering (C<on_line_update>) to underline urls. |
67 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item block-graphics-to-ascii |
|
|
70 | |
|
|
71 | A not very useful example of filtering all text output to the terminal, |
|
|
72 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
73 | similar-looking ascii character. |
| 68 | |
74 | |
| 69 | =item example-refresh-hooks |
75 | =item example-refresh-hooks |
| 70 | |
76 | |
| 71 | Displays a very simple digital clock in the upper right corner of the |
77 | Displays a very simple digital clock in the upper right corner of the |
| 72 | window. Illustrates overwriting the refresh callbacks to create your own |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
| 73 | overlays or changes. |
79 | overlays or changes. |
| 74 | |
|
|
| 75 | =item example-filter-input |
|
|
| 76 | |
|
|
| 77 | A not very useful example of filtering all text output to the terminal, by |
|
|
| 78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
| 79 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
| 80 | when typing them) do not get marked. |
|
|
| 81 | |
80 | |
| 82 | =back |
81 | =back |
| 83 | |
82 | |
| 84 | =head2 General API Considerations |
83 | =head2 General API Considerations |
| 85 | |
84 | |
| … | |
… | |
| 271 | |
270 | |
| 272 | =item on_button_release $term, $event |
271 | =item on_button_release $term, $event |
| 273 | |
272 | |
| 274 | =item on_motion_notify $term, $event |
273 | =item on_motion_notify $term, $event |
| 275 | |
274 | |
| 276 | Called whenever the corresponding X event is received for the terminal |
275 | Called whenever the corresponding X event is received for the terminal If |
| 277 | (see the XEvent manpage) If the hook returns true, then the even will be |
276 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 278 | ignored by rxvt-unicode. |
277 | |
|
|
278 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
279 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
280 | and column under the mouse cursor. |
| 279 | |
281 | |
| 280 | C<on_key_press> additionally receives the string rxvt-unicode would |
282 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 281 | output, if any, in locale-specific encoding. |
283 | output, if any, in locale-specific encoding. |
| 282 | |
284 | |
| 283 | subwindow. |
285 | subwindow. |
| … | |
… | |
| 462 | my $htype = shift; |
464 | my $htype = shift; |
| 463 | |
465 | |
| 464 | if ($htype == 0) { # INIT |
466 | if ($htype == 0) { # INIT |
| 465 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
467 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 466 | |
468 | |
| 467 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
469 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
| 468 | my @files = grep -f $_, map "$_/$ext", @dirs; |
470 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| 469 | |
471 | |
| 470 | if (@files) { |
472 | if (@files) { |
| 471 | register_package script_package $files[0]; |
473 | register_package script_package $files[0]; |
| 472 | } else { |
474 | } else { |
| … | |
… | |
| 660 | |
662 | |
| 661 | If hidden, display the overlay again. |
663 | If hidden, display the overlay again. |
| 662 | |
664 | |
| 663 | =back |
665 | =back |
| 664 | |
666 | |
| 665 | =item $cellwidth = $term->strwidth $string |
667 | =item $cellwidth = $term->strwidth ($string) |
| 666 | |
668 | |
| 667 | Returns the number of screen-cells this string would need. Correctly |
669 | Returns the number of screen-cells this string would need. Correctly |
| 668 | accounts for wide and combining characters. |
670 | accounts for wide and combining characters. |
| 669 | |
671 | |
| 670 | =item $octets = $term->locale_encode $string |
672 | =item $octets = $term->locale_encode ($string) |
| 671 | |
673 | |
| 672 | Convert the given text string into the corresponding locale encoding. |
674 | Convert the given text string into the corresponding locale encoding. |
| 673 | |
675 | |
| 674 | =item $string = $term->locale_decode $octets |
676 | =item $string = $term->locale_decode ($octets) |
| 675 | |
677 | |
| 676 | Convert the given locale-encoded octets into a perl string. |
678 | Convert the given locale-encoded octets into a perl string. |
| 677 | |
679 | |
| 678 | =item $term->scr_add_lines ($string) |
680 | =item $term->scr_add_lines ($string) |
| 679 | |
681 | |
| … | |
… | |
| 695 | =item $term->tt_write ($octets) |
697 | =item $term->tt_write ($octets) |
| 696 | |
698 | |
| 697 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
699 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
| 698 | pass characters instead of octets, you should convert your strings first |
700 | pass characters instead of octets, you should convert your strings first |
| 699 | to the locale-specific encoding using C<< $term->locale_encode >>. |
701 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
702 | |
|
|
703 | =item $windowid = $term->parent |
|
|
704 | |
|
|
705 | Return the window id of the toplevel window. |
|
|
706 | |
|
|
707 | =item $windowid = $term->vt |
|
|
708 | |
|
|
709 | Return the window id of the terminal window. |
| 700 | |
710 | |
| 701 | =item $window_width = $term->width |
711 | =item $window_width = $term->width |
| 702 | |
712 | |
| 703 | =item $window_height = $term->height |
713 | =item $window_height = $term->height |
| 704 | |
714 | |
