… | |
… | |
179 | should extend the selection itelf and return true to suppress the built-in |
179 | should extend the selection itelf and return true to suppress the built-in |
180 | processing. |
180 | processing. |
181 | |
181 | |
182 | See the F<selection> example extension. |
182 | See the F<selection> example extension. |
183 | |
183 | |
184 | =item on_focus_in $term |
|
|
185 | |
|
|
186 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
187 | focus in processing. |
|
|
188 | |
|
|
189 | =item on_focus_out $term |
|
|
190 | |
|
|
191 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
192 | out processing. |
|
|
193 | |
|
|
194 | =item on_view_change $term, $offset |
184 | =item on_view_change $term, $offset |
195 | |
185 | |
196 | Called whenever the view offset changes, i..e the user or program |
186 | Called whenever the view offset changes, i..e the user or program |
197 | scrolls. Offset C<0> means display the normal terminal, positive values |
187 | scrolls. Offset C<0> means display the normal terminal, positive values |
198 | show this many lines of scrollback. |
188 | show this many lines of scrollback. |
… | |
… | |
261 | |
251 | |
262 | Called whenever the user presses a key combination that has a |
252 | Called whenever the user presses a key combination that has a |
263 | C<perl:string> action bound to it (see description of the B<keysym> |
253 | C<perl:string> action bound to it (see description of the B<keysym> |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
254 | resource in the @@RXVT_NAME@@(1) manpage). |
265 | |
255 | |
|
|
256 | =item on_focus_in $term |
|
|
257 | |
|
|
258 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
259 | does focus in processing. |
|
|
260 | |
|
|
261 | =item on_focus_out $term |
|
|
262 | |
|
|
263 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
264 | focus out processing. |
|
|
265 | |
266 | =item on_key_press $term, $event, $octets |
266 | =item on_key_press $term, $event, $octets |
267 | |
267 | |
268 | =item on_key_release $term, $event |
268 | =item on_key_release $term, $event |
269 | |
269 | |
270 | =item on_button_press $term, $event |
270 | =item on_button_press $term, $event |
271 | |
271 | |
272 | =item on_button_release $term, $event |
272 | =item on_button_release $term, $event |
273 | |
273 | |
274 | =item on_motion_notify $term, $event |
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | =item on_map_notify $term, $event |
|
|
277 | |
|
|
278 | =item on_unmap_notify $term, $event |
275 | |
279 | |
276 | Called whenever the corresponding X event is received for the terminal If |
280 | Called whenever the corresponding X event is received for the terminal If |
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
281 | the hook returns true, then the even will be ignored by rxvt-unicode. |
278 | |
282 | |
279 | The event is a hash with most values as named by Xlib (see the XEvent |
283 | The event is a hash with most values as named by Xlib (see the XEvent |
… | |
… | |
327 | |
331 | |
328 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
329 | |
333 | |
330 | Returns the "current time" (as per the event loop). |
334 | Returns the "current time" (as per the event loop). |
331 | |
335 | |
|
|
336 | =item urxvt::CurrentTime |
|
|
337 | |
|
|
338 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
339 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
340 | Button4Mask, Button5Mask, AnyModifier |
|
|
341 | |
|
|
342 | Various constants for use in X events. |
|
|
343 | |
332 | =back |
344 | =back |
333 | |
345 | |
334 | =head2 RENDITION |
346 | =head2 RENDITION |
335 | |
347 | |
336 | Rendition bitsets contain information about colour, font, font styles and |
348 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
385 | |
397 | |
386 | =cut |
398 | =cut |
387 | |
399 | |
388 | package urxvt; |
400 | package urxvt; |
389 | |
401 | |
|
|
402 | use utf8; |
390 | use strict; |
403 | use strict; |
391 | use Scalar::Util (); |
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
392 | |
406 | |
393 | our $TERM; |
407 | our $TERM; |
394 | our @HOOKNAME; |
408 | our @HOOKNAME; |
395 | our $LIBDIR; |
409 | our $LIBDIR; |
396 | |
410 | |
… | |
… | |
534 | } or die "FATAL: unable to compile method forwarder: $@"; |
548 | } or die "FATAL: unable to compile method forwarder: $@"; |
535 | |
549 | |
536 | goto &$urxvt::term::proxy::AUTOLOAD; |
550 | goto &$urxvt::term::proxy::AUTOLOAD; |
537 | } |
551 | } |
538 | |
552 | |
|
|
553 | sub urxvt::destroy_hook::DESTROY { |
|
|
554 | ${$_[0]}->(); |
|
|
555 | } |
|
|
556 | |
|
|
557 | sub urxvt::destroy_hook(&) { |
|
|
558 | bless \shift, urxvt::destroy_hook:: |
|
|
559 | } |
|
|
560 | |
539 | =head2 The C<urxvt::term> Class |
561 | =head2 The C<urxvt::term> Class |
540 | |
562 | |
541 | =over 4 |
563 | =over 4 |
542 | |
564 | |
543 | =item $term->destroy |
565 | =item $term->destroy |
… | |
… | |
581 | =cut |
603 | =cut |
582 | |
604 | |
583 | sub urxvt::term::resource($$;$) { |
605 | sub urxvt::term::resource($$;$) { |
584 | my ($self, $name) = (shift, shift); |
606 | my ($self, $name) = (shift, shift); |
585 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
607 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
586 | goto &urxvt::term::_resource; |
608 | &urxvt::term::_resource |
587 | } |
609 | } |
588 | |
610 | |
589 | =item $rend = $term->rstyle ([$new_rstyle]) |
611 | =item $rend = $term->rstyle ([$new_rstyle]) |
590 | |
612 | |
591 | Return and optionally change the current rendition. Text that is output by |
613 | Return and optionally change the current rendition. Text that is output by |
… | |
… | |
667 | |
689 | |
668 | If hidden, display the overlay again. |
690 | If hidden, display the overlay again. |
669 | |
691 | |
670 | =back |
692 | =back |
671 | |
693 | |
|
|
694 | =item $popup = $term->popup ($event) |
|
|
695 | |
|
|
696 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
697 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
698 | currently). |
|
|
699 | |
|
|
700 | =cut |
|
|
701 | |
|
|
702 | sub urxvt::term::popup { |
|
|
703 | my ($self, $event) = @_; |
|
|
704 | |
|
|
705 | $self->grab ($event->{time}, 1) |
|
|
706 | or return; |
|
|
707 | |
|
|
708 | my $popup = bless { |
|
|
709 | term => $self, |
|
|
710 | event => $event, |
|
|
711 | }, urxvt::popup::; |
|
|
712 | |
|
|
713 | Scalar::Util::weaken $popup->{term}; |
|
|
714 | |
|
|
715 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
716 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
717 | |
|
|
718 | $popup |
|
|
719 | } |
|
|
720 | |
672 | =item $cellwidth = $term->strwidth ($string) |
721 | =item $cellwidth = $term->strwidth ($string) |
673 | |
722 | |
674 | Returns the number of screen-cells this string would need. Correctly |
723 | Returns the number of screen-cells this string would need. Correctly |
675 | accounts for wide and combining characters. |
724 | accounts for wide and combining characters. |
676 | |
725 | |
… | |
… | |
736 | =item $nrow_plus_saveLines = $term->total_rows |
785 | =item $nrow_plus_saveLines = $term->total_rows |
737 | |
786 | |
738 | =item $lines_in_scrollback = $term->nsaved |
787 | =item $lines_in_scrollback = $term->nsaved |
739 | |
788 | |
740 | Return various integers describing terminal characteristics. |
789 | Return various integers describing terminal characteristics. |
|
|
790 | |
|
|
791 | =item $modifiermask = $term->ModLevel3Mask |
|
|
792 | |
|
|
793 | =item $modifiermask = $term->ModMetaMask |
|
|
794 | |
|
|
795 | =item $modifiermask = $term->ModNumLockMask |
|
|
796 | |
|
|
797 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
798 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
741 | |
799 | |
742 | =item $view_start = $term->view_start ([$newvalue]) |
800 | =item $view_start = $term->view_start ([$newvalue]) |
743 | |
801 | |
744 | Returns the negative row number of the topmost line. Minimum value is |
802 | Returns the negative row number of the topmost line. Minimum value is |
745 | C<0>, which displays the normal terminal contents. Larger values scroll |
803 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
926 | |
984 | |
927 | Converts rxvt-unicodes text reprsentation into a perl string. See |
985 | Converts rxvt-unicodes text reprsentation into a perl string. See |
928 | C<< $term->ROW_t >> for details. |
986 | C<< $term->ROW_t >> for details. |
929 | |
987 | |
930 | =back |
988 | =back |
|
|
989 | |
|
|
990 | =head2 The C<urxvt::popup> Class |
|
|
991 | |
|
|
992 | =over 4 |
|
|
993 | |
|
|
994 | =cut |
|
|
995 | |
|
|
996 | package urxvt::popup; |
|
|
997 | |
|
|
998 | sub add_item { |
|
|
999 | my ($self, $item) = @_; |
|
|
1000 | |
|
|
1001 | push @{ $self->{item} }, $item; |
|
|
1002 | } |
|
|
1003 | |
|
|
1004 | sub add_button { |
|
|
1005 | my ($self, $text, $cb) = @_; |
|
|
1006 | |
|
|
1007 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, |
|
|
1008 | render => sub { $_[0]{text} }, |
|
|
1009 | }); |
|
|
1010 | } |
|
|
1011 | |
|
|
1012 | sub add_toggle { |
|
|
1013 | my ($self, $text, $cb, $value) = @_; |
|
|
1014 | |
|
|
1015 | $self->add_item ({ type => "button", text => " $text", value => $value, |
|
|
1016 | render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 }, |
|
|
1017 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
|
|
1018 | }); |
|
|
1019 | } |
|
|
1020 | |
|
|
1021 | sub show { |
|
|
1022 | my ($self) = @_; |
|
|
1023 | |
|
|
1024 | local $urxvt::popup::self = $self; |
|
|
1025 | |
|
|
1026 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1027 | "--transient-for" => $self->{term}->parent, |
|
|
1028 | "-pe" => "urxvt-popup") |
|
|
1029 | or die "unable to create popup window\n"; |
|
|
1030 | } |
|
|
1031 | |
|
|
1032 | sub DESTROY { |
|
|
1033 | my ($self) = @_; |
|
|
1034 | |
|
|
1035 | $self->{term}->ungrab; |
|
|
1036 | } |
931 | |
1037 | |
932 | =head2 The C<urxvt::timer> Class |
1038 | =head2 The C<urxvt::timer> Class |
933 | |
1039 | |
934 | This class implements timer watchers/events. Time is represented as a |
1040 | This class implements timer watchers/events. Time is represented as a |
935 | fractional number of seconds since the epoch. Example: |
1041 | fractional number of seconds since the epoch. Example: |