ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.43 by root, Sat Jan 7 04:19:43 2006 UTC

… …
62 62
63Displays a digital clock using the built-in overlay. 63Displays a digital clock using the built-in overlay.
64 64
65=item mark-urls 65=item mark-urls
66 66
67Uses per-line filtering (C<on_line_update>) to underline urls. 67Uses per-line display filtering (C<on_line_update>) to underline urls.
68
69=item block-graphics-to-ascii
70
71A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a
73similar-looking ascii character.
68 74
69=item example-refresh-hooks 75=item example-refresh-hooks
70 76
71Displays a very simple digital clock in the upper right corner of the 77Displays a very simple digital clock in the upper right corner of the
72window. Illustrates overwriting the refresh callbacks to create your own 78window. Illustrates overwriting the refresh callbacks to create your own
73overlays or changes. 79overlays or changes.
74
75=item example-filter-input
76
77A not very useful example of filtering all text output to the terminal, by
78underlining all urls that matches a certain regex (i.e. some urls :). It
79is not very useful because urls that are output in multiple steps (e.g.
80when 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
… …
117 116
118=back 117=back
119 118
120=head2 Hooks 119=head2 Hooks
121 120
122The following subroutines can be declared in loaded scripts, and will be 121The following subroutines can be declared in extension files, and will be
123called whenever the relevant event happens. 122called whenever the relevant event happens.
124 123
125The first argument passed to them is an object private to each terminal 124The first argument passed to them is an object private to each terminal
126and extension package. You can call all C<urxvt::term> methods on it, but 125and extension package. You can call all C<urxvt::term> methods on it, but
127its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> 126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
… …
291 290
292=over 4 291=over 4
293 292
294=item $urxvt::TERM 293=item $urxvt::TERM
295 294
296The current terminal. Whenever a callback/Hook is bein executed, this 295The current terminal. This variable stores the current C<urxvt::term>
297variable stores the current C<urxvt::term> object. 296object, whenever a callback/hook is executing.
298 297
299=back 298=back
300 299
301=head2 Functions in the C<urxvt> Package 300=head2 Functions in the C<urxvt> Package
302 301
… …
465 my $htype = shift; 464 my $htype = shift;
466 465
467 if ($htype == 0) { # INIT 466 if ($htype == 0) { # INIT
468 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 467 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
469 468
470 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { 469 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
471 my @files = grep -f $_, map "$_/$ext", @dirs; 470 my @files = grep -f $_, map "$_/$ext", @dirs;
472 471
473 if (@files) { 472 if (@files) {
474 register_package script_package $files[0]; 473 register_package script_package $files[0];
475 } else { 474 } else {
… …
663 662
664If hidden, display the overlay again. 663If hidden, display the overlay again.
665 664
666=back 665=back
667 666
668=item $cellwidth = $term->strwidth $string 667=item $cellwidth = $term->strwidth ($string)
669 668
670Returns the number of screen-cells this string would need. Correctly 669Returns the number of screen-cells this string would need. Correctly
671accounts for wide and combining characters. 670accounts for wide and combining characters.
672 671
673=item $octets = $term->locale_encode $string 672=item $octets = $term->locale_encode ($string)
674 673
675Convert the given text string into the corresponding locale encoding. 674Convert the given text string into the corresponding locale encoding.
676 675
677=item $string = $term->locale_decode $octets 676=item $string = $term->locale_decode ($octets)
678 677
679Convert the given locale-encoded octets into a perl string. 678Convert the given locale-encoded octets into a perl string.
680 679
681=item $term->scr_add_lines ($string) 680=item $term->scr_add_lines ($string)
682 681
… …
698=item $term->tt_write ($octets) 697=item $term->tt_write ($octets)
699 698
700Write the octets given in C<$data> to the tty (i.e. as program input). To 699Write the octets given in C<$data> to the tty (i.e. as program input). To
701pass characters instead of octets, you should convert your strings first 700pass characters instead of octets, you should convert your strings first
702to the locale-specific encoding using C<< $term->locale_encode >>. 701to the locale-specific encoding using C<< $term->locale_encode >>.
702
703=item $windowid = $term->parent
704
705Return the window id of the toplevel window.
706
707=item $windowid = $term->vt
708
709Return the window id of the terminal window.
703 710
704=item $window_width = $term->width 711=item $window_width = $term->width
705 712
706=item $window_height = $term->height 713=item $window_height = $term->height
707 714

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines