| … | |
… | |
| 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 |
| … | |
… | |
| 326 | correct place, e.g. on stderr of the connecting urxvtc client. |
330 | correct place, e.g. on stderr of the connecting urxvtc client. |
| 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). |
|
|
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. |
| 331 | |
343 | |
| 332 | =back |
344 | =back |
| 333 | |
345 | |
| 334 | =head2 RENDITION |
346 | =head2 RENDITION |
| 335 | |
347 | |
| … | |
… | |
| 534 | } or die "FATAL: unable to compile method forwarder: $@"; |
546 | } or die "FATAL: unable to compile method forwarder: $@"; |
| 535 | |
547 | |
| 536 | goto &$urxvt::term::proxy::AUTOLOAD; |
548 | goto &$urxvt::term::proxy::AUTOLOAD; |
| 537 | } |
549 | } |
| 538 | |
550 | |
|
|
551 | sub urxvt::destroy_hook::DESTROY { |
|
|
552 | ${$_[0]}->(); |
|
|
553 | } |
|
|
554 | |
|
|
555 | sub urxvt::destroy_hook(&) { |
|
|
556 | bless \shift, urxvt::destroy_hook:: |
|
|
557 | } |
|
|
558 | |
| 539 | =head2 The C<urxvt::term> Class |
559 | =head2 The C<urxvt::term> Class |
| 540 | |
560 | |
| 541 | =over 4 |
561 | =over 4 |
| 542 | |
562 | |
| 543 | =item $term->destroy |
563 | =item $term->destroy |
| … | |
… | |
| 581 | =cut |
601 | =cut |
| 582 | |
602 | |
| 583 | sub urxvt::term::resource($$;$) { |
603 | sub urxvt::term::resource($$;$) { |
| 584 | my ($self, $name) = (shift, shift); |
604 | my ($self, $name) = (shift, shift); |
| 585 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
605 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
| 586 | goto &urxvt::term::_resource; |
606 | &urxvt::term::_resource |
| 587 | } |
607 | } |
| 588 | |
608 | |
| 589 | =item $rend = $term->rstyle ([$new_rstyle]) |
609 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 590 | |
610 | |
| 591 | Return and optionally change the current rendition. Text that is output by |
611 | Return and optionally change the current rendition. Text that is output by |
| … | |
… | |
| 667 | |
687 | |
| 668 | If hidden, display the overlay again. |
688 | If hidden, display the overlay again. |
| 669 | |
689 | |
| 670 | =back |
690 | =back |
| 671 | |
691 | |
|
|
692 | =item $popup = $term->popup ($event) |
|
|
693 | |
|
|
694 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
695 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
696 | currently). |
|
|
697 | |
|
|
698 | =cut |
|
|
699 | |
|
|
700 | sub urxvt::term::popup { |
|
|
701 | my ($self, $event) = @_; |
|
|
702 | |
|
|
703 | $self->grab ($event->{time}, 1) |
|
|
704 | or return; |
|
|
705 | |
|
|
706 | my $popup = bless { |
|
|
707 | term => $self, |
|
|
708 | event => $event, |
|
|
709 | }, urxvt::popup::; |
|
|
710 | |
|
|
711 | Scalar::Util::weaken $popup->{term}; |
|
|
712 | |
|
|
713 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
714 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
715 | |
|
|
716 | $popup |
|
|
717 | } |
|
|
718 | |
| 672 | =item $cellwidth = $term->strwidth ($string) |
719 | =item $cellwidth = $term->strwidth ($string) |
| 673 | |
720 | |
| 674 | Returns the number of screen-cells this string would need. Correctly |
721 | Returns the number of screen-cells this string would need. Correctly |
| 675 | accounts for wide and combining characters. |
722 | accounts for wide and combining characters. |
| 676 | |
723 | |
| … | |
… | |
| 736 | =item $nrow_plus_saveLines = $term->total_rows |
783 | =item $nrow_plus_saveLines = $term->total_rows |
| 737 | |
784 | |
| 738 | =item $lines_in_scrollback = $term->nsaved |
785 | =item $lines_in_scrollback = $term->nsaved |
| 739 | |
786 | |
| 740 | Return various integers describing terminal characteristics. |
787 | Return various integers describing terminal characteristics. |
|
|
788 | |
|
|
789 | =item $modifiermask = $term->ModLevel3Mask |
|
|
790 | |
|
|
791 | =item $modifiermask = $term->ModMetaMask |
|
|
792 | |
|
|
793 | =item $modifiermask = $term->ModNumLockMask |
|
|
794 | |
|
|
795 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
796 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
| 741 | |
797 | |
| 742 | =item $view_start = $term->view_start ([$newvalue]) |
798 | =item $view_start = $term->view_start ([$newvalue]) |
| 743 | |
799 | |
| 744 | Returns the negative row number of the topmost line. Minimum value is |
800 | Returns the negative row number of the topmost line. Minimum value is |
| 745 | C<0>, which displays the normal terminal contents. Larger values scroll |
801 | C<0>, which displays the normal terminal contents. Larger values scroll |
| … | |
… | |
| 926 | |
982 | |
| 927 | Converts rxvt-unicodes text reprsentation into a perl string. See |
983 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 928 | C<< $term->ROW_t >> for details. |
984 | C<< $term->ROW_t >> for details. |
| 929 | |
985 | |
| 930 | =back |
986 | =back |
|
|
987 | |
|
|
988 | =head2 The C<urxvt::popup> Class |
|
|
989 | |
|
|
990 | =over 4 |
|
|
991 | |
|
|
992 | =cut |
|
|
993 | |
|
|
994 | package urxvt::popup; |
|
|
995 | |
|
|
996 | sub add_item { |
|
|
997 | my ($self, $item) = @_; |
|
|
998 | |
|
|
999 | push @{ $self->{item} }, $item; |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | sub add_button { |
|
|
1003 | my ($self, $text, $cb) = @_; |
|
|
1004 | |
|
|
1005 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); |
|
|
1006 | } |
|
|
1007 | |
|
|
1008 | sub show { |
|
|
1009 | my ($self) = @_; |
|
|
1010 | |
|
|
1011 | local $urxvt::popup::self = $self; |
|
|
1012 | |
|
|
1013 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1014 | "--transient-for" => $self->{term}->parent, |
|
|
1015 | "-pe" => "urxvt-popup") |
|
|
1016 | or die "unable to create popup window\n"; |
|
|
1017 | } |
|
|
1018 | |
|
|
1019 | sub DESTROY { |
|
|
1020 | my ($self) = @_; |
|
|
1021 | |
|
|
1022 | $self->{term}->ungrab; |
|
|
1023 | } |
| 931 | |
1024 | |
| 932 | =head2 The C<urxvt::timer> Class |
1025 | =head2 The C<urxvt::timer> Class |
| 933 | |
1026 | |
| 934 | This class implements timer watchers/events. Time is represented as a |
1027 | This class implements timer watchers/events. Time is represented as a |
| 935 | fractional number of seconds since the epoch. Example: |
1028 | fractional number of seconds since the epoch. Example: |
