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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 71
68You can look at the source of the selection extension to see more 72You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 73interesting uses, such as parsing a line from beginning to end.
70 74
71This extension also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
72 76
73=over 4 77=over 4
74 78
75=item rot13 79=item rot13
76 80
88=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
93 116
94=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
95 118
96Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
120 143
121For example, the following will transform selections of the form 144For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 145C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 146$word>:
124 147
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 149
127And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
129 152
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 154
132Of course, this can be modified to suit your needs and your editor :) 155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
133 166
134=item mark-urls 167=item mark-urls
135 168
136Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
137make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
138resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
139the URL as first argument. 172the URL as first argument.
140 173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
141=item block-graphics-to-ascii 182=item block-graphics-to-ascii
142 183
143A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
144by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
145similar-looking ascii character. 186similar-looking ascii character.
151=item example-refresh-hooks 192=item example-refresh-hooks
152 193
153Displays a very simple digital clock in the upper right corner of the 194Displays a very simple digital clock in the upper right corner of the
154window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
155overlays or changes. 196overlays or changes.
197
198=item selection-pastebin
199
200This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
207
208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
212
213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215And the default is likely not useful to anybody but the few people around
216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
221After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
224
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
156 226
157=back 227=back
158 228
159=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
160 230
233called whenever the relevant event happens. 303called whenever the relevant event happens.
234 304
235The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
236the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
237 307
238B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
239event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
240skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
241 311
242I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
243 313
244=over 4 314=over 4
245 315
246=item on_init $term 316=item on_init $term
247 317
248Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
249windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
250call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
251have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
252though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop.
253 329
254=item on_reset $term 330=item on_reset $term
255 331
256Called after the screen is "reset" for any reason, such as resizing or 332Called after the screen is "reset" for any reason, such as resizing or
257control sequences. Here is where you can react on changes to size-related 333control sequences. Here is where you can react on changes to size-related
258variables. 334variables.
259 335
260=item on_start $term 336=item on_child_start $term, $pid
261 337
262Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
263returning to the mainloop. 339
340=item on_child_exit $term, $status
341
342Called just after the child process has exited. C<$status> is the status
343from C<waitpid>.
264 344
265=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
266 346
267Called whenever a selection has been made by the user, but before the 347Called whenever a selection has been made by the user, but before the
268selection text is copied, so changes to the beginning, end or type of the 348selection text is copied, so changes to the beginning, end or type of the
361 441
362Called whenever the user presses a key combination that has a 442Called whenever the user presses a key combination that has a
363C<perl:string> action bound to it (see description of the B<keysym> 443C<perl:string> action bound to it (see description of the B<keysym>
364resource in the @@RXVT_NAME@@(1) manpage). 444resource in the @@RXVT_NAME@@(1) manpage).
365 445
446=item on_x_event $term, $event
447
448Called on every X event received on the vt window (and possibly other
449windows). Should only be used as a last resort. Most event structure
450members are not passed.
451
366=item on_focus_in $term 452=item on_focus_in $term
367 453
368Called whenever the window gets the keyboard focus, before rxvt-unicode 454Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 455does focus in processing.
370 456
371=item on_focus_out $term 457=item on_focus_out $term
372 458
373Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
374focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
375 463
376=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
377 465
378=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
379 467
465Using this function has the advantage that its output ends up in the 553Using this function has the advantage that its output ends up in the
466correct place, e.g. on stderr of the connecting urxvtc client. 554correct place, e.g. on stderr of the connecting urxvtc client.
467 555
468Messages have a size limit of 1023 bytes currently. 556Messages have a size limit of 1023 bytes currently.
469 557
470=item $is_safe = urxvt::safe
471
472Returns true when it is safe to do potentially unsafe things, such as
473evaluating perl code specified by the user. This is true when urxvt was
474started setuid or setgid.
475
476=item $time = urxvt::NOW 558=item $time = urxvt::NOW
477 559
478Returns the "current time" (as per the event loop). 560Returns the "current time" (as per the event loop).
479 561
480=item urxvt::CurrentTime 562=item urxvt::CurrentTime
481 563
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 564=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 565Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, Button5Mask, AnyModifier 566Button4Mask, Button5Mask, AnyModifier
567
568=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
569ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
570PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
571Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
572KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
573ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
574FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
575
576=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
577EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
578GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
579UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
580ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
581CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
582SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485 583
486Various constants for use in X calls and event processing. 584Various constants for use in X calls and event processing.
487 585
488=back 586=back
489 587
540=back 638=back
541 639
542=cut 640=cut
543 641
544BEGIN { 642BEGIN {
545 urxvt->bootstrap;
546
547 # overwrite perl's warn 643 # overwrite perl's warn
548 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
549 my $msg = join "", @_; 645 my $msg = join "", @_;
550 $msg .= "\n" 646 $msg .= "\n"
551 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
552 urxvt::warn ($msg); 648 urxvt::warn ($msg);
553 }; 649 };
554
555 # %ENV is the original startup environment
556 delete $ENV{IFS};
557 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV};
559 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560} 650}
561 651
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 653
565sub verbose { 654sub verbose {
566 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
568} 657}
569 658
570my $extension_pkg = "extension0000";
571my %extension_pkg; 659my %extension_pkg;
572 660
573# load a single script into its own package, once only 661# load a single script into its own package, once only
574sub extension_package($) { 662sub extension_package($) {
575 my ($path) = @_; 663 my ($path) = @_;
576 664
665 no strict 'refs';
666
577 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
578 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
579 672
580 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
581 674
582 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
583 or die "$path: $!"; 676 or die "$path: $!";
584 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
585 my $source = untaint 680 my $source =
586 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
590 . "\n};\n1"; 684 . "\n};\n1";
591 685
592 eval $source 686 eval $source
641 if $verbosity >= 10; 735 if $verbosity >= 10;
642 736
643 keys %$cb; 737 keys %$cb;
644 738
645 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
646 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
647 and last;
648 741
649 if ($@) { 742 if ($@) {
650 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
651 warn $@; 744 warn $@;
652 } 745 }
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 749 if $verbosity >= 11;
657 } 750 }
658 751
659 if ($htype == 1) { # DESTROY 752 if ($htype == 1) { # DESTROY
660 if (my $hook = delete $TERM->{_hook}) {
661 for my $htype (0..$#$hook) {
662 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663 or set_should_invoke $htype, 0;
664 }
665 }
666
667 # clear package objects 753 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
669 755
670 # clear package 756 # clear package
671 %$TERM = (); 757 %$TERM = ();
672 } 758 }
673 759
674 $retval 760 $retval
675}
676
677sub exec_async(@) {
678 my $pid = fork;
679
680 return
681 if !defined $pid or $pid;
682
683 %ENV = %{ $TERM->env };
684
685 exec @_;
686 _exit 255;
687} 761}
688 762
689# urxvt::term::extension 763# urxvt::term::extension
690 764
691package urxvt::term::extension; 765package urxvt::term::extension;
697 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 773 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
701 775
776 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 778
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 780 }
709} 781}
710 782
715 for my $name (@hook) { 787 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 789 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
719 791
792 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 794 }
725} 795}
726 796
727our $AUTOLOAD; 797our $AUTOLOAD;
728 798
874 944
875Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
876etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
877watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
878 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
879=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
880 975
881Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
882optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
883C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
885Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
886source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
887 982
888 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
889 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
890 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
891 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
892 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
893 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
894 989
895=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
896 991
897Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
898optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
915 1010
916 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
917 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
918 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
919 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
920 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
921 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
927 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
928 1024
929=cut 1025=cut
930 1026
931sub resource($$;$) { 1027sub resource($$;$) {
932 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
1133 1229
1134=item $windowid = $term->vt 1230=item $windowid = $term->vt
1135 1231
1136Return the window id of the terminal window. 1232Return the window id of the terminal window.
1137 1233
1234=item $term->vt_emask_add ($x_event_mask)
1235
1236Adds the specified events to the vt event mask. Useful e.g. when you want
1237to receive pointer events all the times:
1238
1239 $term->vt_emask_add (urxvt::PointerMotionMask);
1240
1138=item $window_width = $term->width 1241=item $window_width = $term->width
1139 1242
1140=item $window_height = $term->height 1243=item $window_height = $term->height
1141 1244
1142=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1155 1258
1156=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1157 1260
1158=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1159 1262
1160=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1161 1264
1162Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1163 1266
1164=item $x_display = $term->display_id 1267=item $x_display = $term->display_id
1165 1268
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), the meta key (often Alt) and the num lock key, if applicable. 1297AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195 1298
1196=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1197 1300
1198Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1201 1304
1202=item $term->want_refresh 1305=item $term->want_refresh
1203 1306
1204Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1517 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1518 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1520 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1521 1624
1522 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1523 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1525 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1526 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1527 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1528} 1633}
1580Start the timer. 1685Start the timer.
1581 1686
1582=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1583 1688
1584Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585 1694
1586=item $timer = $timer->stop 1695=item $timer = $timer->stop
1587 1696
1588Stop the timer. 1697Stop the timer.
1589 1698

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines