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.89 by root, Thu Jan 12 12:10:06 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/
154
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.
131 166
132=item mark-urls 167=item mark-urls
133 168
134Uses 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
135make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
136resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
137the URL as first argument. 172the URL as first argument.
138 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
139=item block-graphics-to-ascii 182=item block-graphics-to-ascii
140 183
141A 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,
142by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
143similar-looking ascii character. 186similar-looking ascii character.
149=item example-refresh-hooks 192=item example-refresh-hooks
150 193
151Displays 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
152window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
153overlays 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/%
154 226
155=back 227=back
156 228
157=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
158 230
231called whenever the relevant event happens. 303called whenever the relevant event happens.
232 304
233The 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
234the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
235 307
236B<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
237event 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
238skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
239 311
240I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
241 313
242=over 4 314=over 4
243 315
244=item on_init $term 316=item on_init $term
245 317
246Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
247windows 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
248call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
249have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
250though. 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.
251 329
252=item on_reset $term 330=item on_reset $term
253 331
254Called 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
255control 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
256variables. 334variables.
257 335
258=item on_start $term 336=item on_child_start $term, $pid
259 337
260Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
261returning 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>.
262 344
263=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
264 346
265Called 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
266selection 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
359 441
360Called whenever the user presses a key combination that has a 442Called whenever the user presses a key combination that has a
361C<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>
362resource in the @@RXVT_NAME@@(1) manpage). 444resource in the @@RXVT_NAME@@(1) manpage).
363 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
364=item on_focus_in $term 452=item on_focus_in $term
365 453
366Called whenever the window gets the keyboard focus, before rxvt-unicode 454Called whenever the window gets the keyboard focus, before rxvt-unicode
367does focus in processing. 455does focus in processing.
368 456
369=item on_focus_out $term 457=item on_focus_out $term
370 458
371Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
372focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
373 463
374=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
375 465
376=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
377 467
463Using 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
464correct place, e.g. on stderr of the connecting urxvtc client. 554correct place, e.g. on stderr of the connecting urxvtc client.
465 555
466Messages have a size limit of 1023 bytes currently. 556Messages have a size limit of 1023 bytes currently.
467 557
468=item $is_safe = urxvt::safe
469
470Returns true when it is safe to do potentially unsafe things, such as
471evaluating perl code specified by the user. This is true when urxvt was
472started setuid or setgid.
473
474=item $time = urxvt::NOW 558=item $time = urxvt::NOW
475 559
476Returns the "current time" (as per the event loop). 560Returns the "current time" (as per the event loop).
477 561
478=item urxvt::CurrentTime 562=item urxvt::CurrentTime
479 563
480=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 564=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 565Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482Button4Mask, 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
483 583
484Various constants for use in X calls and event processing. 584Various constants for use in X calls and event processing.
485 585
486=back 586=back
487 587
538=back 638=back
539 639
540=cut 640=cut
541 641
542BEGIN { 642BEGIN {
543 urxvt->bootstrap;
544
545 # overwrite perl's warn 643 # overwrite perl's warn
546 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
547 my $msg = join "", @_; 645 my $msg = join "", @_;
548 $msg .= "\n" 646 $msg .= "\n"
549 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
550 urxvt::warn ($msg); 648 urxvt::warn ($msg);
551 }; 649 };
552
553 # %ENV is the original startup environment
554 delete $ENV{IFS};
555 delete $ENV{CDPATH};
556 delete $ENV{BASH_ENV};
557 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558} 650}
559 651
560my @hook_count;
561my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562 653
563sub verbose { 654sub verbose {
564 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
565 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
566} 657}
567 658
568my $extension_pkg = "extension0000";
569my %extension_pkg; 659my %extension_pkg;
570 660
571# load a single script into its own package, once only 661# load a single script into its own package, once only
572sub extension_package($) { 662sub extension_package($) {
573 my ($path) = @_; 663 my ($path) = @_;
574 664
665 no strict 'refs';
666
575 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
576 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
577 672
578 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
579 674
580 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
581 or die "$path: $!"; 676 or die "$path: $!";
582 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
583 my $source = untaint 680 my $source =
584 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
585 . "use base urxvt::term::extension::;\n"
586 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
587 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
588 . "\n};\n1"; 684 . "\n};\n1";
589 685
590 eval $source 686 eval $source
639 if $verbosity >= 10; 735 if $verbosity >= 10;
640 736
641 keys %$cb; 737 keys %$cb;
642 738
643 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
644 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
645 and last;
646 741
647 if ($@) { 742 if ($@) {
648 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
649 warn $@; 744 warn $@;
650 } 745 }
653 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654 if $verbosity >= 11; 749 if $verbosity >= 11;
655 } 750 }
656 751
657 if ($htype == 1) { # DESTROY 752 if ($htype == 1) { # DESTROY
658 if (my $hook = delete $TERM->{_hook}) {
659 for my $htype (0..$#$hook) {
660 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661 or set_should_invoke $htype, 0;
662 }
663 }
664
665 # clear package objects 753 # clear package objects
666 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
667 755
668 # clear package 756 # clear package
669 %$TERM = (); 757 %$TERM = ();
670 } 758 }
671 759
672 $retval 760 $retval
673}
674
675sub exec_async(@) {
676 my $pid = fork;
677
678 return
679 if !defined $pid or $pid;
680
681 %ENV = %{ $TERM->env };
682
683 exec @_;
684 _exit 255;
685} 761}
686 762
687# urxvt::term::extension 763# urxvt::term::extension
688 764
689package urxvt::term::extension; 765package urxvt::term::extension;
695 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
696 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
697 defined $htype 773 defined $htype
698 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
699 775
776 $self->set_should_invoke ($htype, +1)
700 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
701 $hook_count[$htype]++
702 or urxvt::set_should_invoke $htype, 1;
703 }
704 778
705 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
706 } 780 }
707} 781}
708 782
713 for my $name (@hook) { 787 for my $name (@hook) {
714 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
715 defined $htype 789 defined $htype
716 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
717 791
792 $self->set_should_invoke ($htype, -1)
718 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
719 --$hook_count[$htype]
720 or urxvt::set_should_invoke $htype, 0;
721 }
722 } 794 }
723} 795}
724 796
725our $AUTOLOAD; 797our $AUTOLOAD;
726 798
872 944
873Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
874etc.). 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
875watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
876 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
877=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
878 975
879Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
880optionally 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
881C<%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.
883Here 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
884source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
885 982
886 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
887 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
888 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
889 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
890 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
891 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
892 989
893=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
894 991
895Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
896optionally 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>
913 1010
914 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
915 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
916 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
917 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
918 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
919 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
925 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
926 1024
927=cut 1025=cut
928 1026
929sub resource($$;$) { 1027sub resource($$;$) {
930 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
1131 1229
1132=item $windowid = $term->vt 1230=item $windowid = $term->vt
1133 1231
1134Return the window id of the terminal window. 1232Return the window id of the terminal window.
1135 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
1136=item $window_width = $term->width 1241=item $window_width = $term->width
1137 1242
1138=item $window_height = $term->height 1243=item $window_height = $term->height
1139 1244
1140=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1153 1258
1154=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1155 1260
1156=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1157 1262
1158=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1159 1264
1160Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1161 1266
1162=item $x_display = $term->display_id 1267=item $x_display = $term->display_id
1163 1268
1191Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192AltGr), 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.
1193 1298
1194=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1195 1300
1196Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1197C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1198this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1199 1304
1200=item $term->want_refresh 1305=item $term->want_refresh
1201 1306
1202Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1515 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1516 # 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.
1517 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1518 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1519 1624
1520 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1521 "--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",
1522 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1523 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1524 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1525 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1526} 1633}
1578Start the timer. 1685Start the timer.
1579 1686
1580=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1581 1688
1582Set 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>.
1583 1694
1584=item $timer = $timer->stop 1695=item $timer = $timer->stop
1585 1696
1586Stop the timer. 1697Stop the timer.
1587 1698

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines