… | |
… | |
94 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
95 | |
95 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
97 | runtime. |
98 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
99 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
100 | |
117 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
104 | |
121 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
124 | popup is being displayed. |
108 | |
125 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
… | |
… | |
205 | |
222 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
225 | while B<Shift-Down> creates a new tab. |
209 | |
226 | |
|
|
227 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
228 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
229 | following four resources (shown with defaults): |
|
|
230 | |
|
|
231 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
232 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
233 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
235 | |
|
|
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
237 | indices. |
|
|
238 | |
210 | =item mark-urls |
239 | =item mark-urls |
211 | |
240 | |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
241 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
213 | make them clickable. When middle-clicked, the program specified in the |
242 | make them clickable. When middle-clicked, the program specified in the |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
… | |
… | |
242 | |
271 | |
243 | =item digital-clock |
272 | =item digital-clock |
244 | |
273 | |
245 | Displays a digital clock using the built-in overlay. |
274 | Displays a digital clock using the built-in overlay. |
246 | |
275 | |
247 | =item remote-selection |
276 | =item remote-clipboard |
248 | |
277 | |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
278 | Somewhat of a misnomer, this extension adds two menu entries to the |
250 | selection popup that allows one ti run external commands to store the |
279 | selection popup that allows one ti run external commands to store the |
251 | selection somewhere and fetch it again. |
280 | selection somewhere and fetch it again. |
252 | |
281 | |
… | |
… | |
515 | |
544 | |
516 | =item on_refresh_end $term |
545 | =item on_refresh_end $term |
517 | |
546 | |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
547 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
519 | |
548 | |
520 | =item on_keyboard_command $term, $string |
549 | =item on_user_command $term, $string |
521 | |
550 | |
522 | Called whenever the user presses a key combination that has a |
551 | Called whenever the a user-configured event is being activated (e.g. via |
523 | C<perl:string> action bound to it (see description of the B<keysym> |
552 | a C<perl:string> action bound to a key, see description of the B<keysym> |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
553 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
554 | |
|
|
555 | The event is simply the action string. This interface is assumed to change |
|
|
556 | slightly in the future. |
|
|
557 | |
|
|
558 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
559 | |
|
|
560 | Called just after the new window size has been calculcated, but before |
|
|
561 | windows are actually being resized or hints are being set. If this hook |
|
|
562 | returns TRUE, setting of the window hints is being skipped. |
525 | |
563 | |
526 | =item on_x_event $term, $event |
564 | =item on_x_event $term, $event |
527 | |
565 | |
528 | Called on every X event received on the vt window (and possibly other |
566 | Called on every X event received on the vt window (and possibly other |
529 | windows). Should only be used as a last resort. Most event structure |
567 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
664 | Using this function has the advantage that its output ends up in the |
702 | Using this function has the advantage that its output ends up in the |
665 | correct place, e.g. on stderr of the connecting urxvtc client. |
703 | correct place, e.g. on stderr of the connecting urxvtc client. |
666 | |
704 | |
667 | Messages have a size limit of 1023 bytes currently. |
705 | Messages have a size limit of 1023 bytes currently. |
668 | |
706 | |
|
|
707 | =item @terms = urxvt::termlist |
|
|
708 | |
|
|
709 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
710 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
711 | objects that have perl extensions attached will be returned (because there |
|
|
712 | is no urxvt::term objet associated with others). |
|
|
713 | |
669 | =item $time = urxvt::NOW |
714 | =item $time = urxvt::NOW |
670 | |
715 | |
671 | Returns the "current time" (as per the event loop). |
716 | Returns the "current time" (as per the event loop). |
672 | |
717 | |
673 | =item urxvt::CurrentTime |
718 | =item urxvt::CurrentTime |
… | |
… | |
730 | Return the foreground/background colour index, respectively. |
775 | Return the foreground/background colour index, respectively. |
731 | |
776 | |
732 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
777 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
733 | |
778 | |
734 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
779 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
780 | |
|
|
781 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
735 | |
782 | |
736 | Replace the foreground/background colour in the rendition mask with the |
783 | Replace the foreground/background colour in the rendition mask with the |
737 | specified one. |
784 | specified one. |
738 | |
785 | |
739 | =item $value = urxvt::GET_CUSTOM $rend |
786 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
830 | } else { |
877 | } else { |
831 | $ext_arg{$_} ||= []; |
878 | $ext_arg{$_} ||= []; |
832 | } |
879 | } |
833 | } |
880 | } |
834 | |
881 | |
835 | while (my ($ext, $argv) = each %ext_arg) { |
882 | for my $ext (sort keys %ext_arg) { |
836 | my @files = grep -f $_, map "$_/$ext", @dirs; |
883 | my @files = grep -f $_, map "$_/$ext", @dirs; |
837 | |
884 | |
838 | if (@files) { |
885 | if (@files) { |
839 | $TERM->register_package (extension_package $files[0], $argv); |
886 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
840 | } else { |
887 | } else { |
841 | warn "perl extension '$ext' not found in perl library search path\n"; |
888 | warn "perl extension '$ext' not found in perl library search path\n"; |
842 | } |
889 | } |
843 | } |
890 | } |
844 | |
891 | |
… | |
… | |
875 | # clear package |
922 | # clear package |
876 | %$TERM = (); |
923 | %$TERM = (); |
877 | } |
924 | } |
878 | |
925 | |
879 | $retval |
926 | $retval |
|
|
927 | } |
|
|
928 | |
|
|
929 | sub SET_COLOR($$$) { |
|
|
930 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
880 | } |
931 | } |
881 | |
932 | |
882 | # urxvt::term::extension |
933 | # urxvt::term::extension |
883 | |
934 | |
884 | package urxvt::term::extension; |
935 | package urxvt::term::extension; |
… | |
… | |
1053 | hash which defines the environment of the new terminal. |
1104 | hash which defines the environment of the new terminal. |
1054 | |
1105 | |
1055 | Croaks (and probably outputs an error message) if the new instance |
1106 | Croaks (and probably outputs an error message) if the new instance |
1056 | couldn't be created. Returns C<undef> if the new instance didn't |
1107 | couldn't be created. Returns C<undef> if the new instance didn't |
1057 | initialise perl, and the terminal object otherwise. The C<init> and |
1108 | initialise perl, and the terminal object otherwise. The C<init> and |
1058 | C<start> hooks will be called during this call. |
1109 | C<start> hooks will be called before this call returns, and are free to |
|
|
1110 | refer to global data (which is race free). |
1059 | |
1111 | |
1060 | =cut |
1112 | =cut |
1061 | |
1113 | |
1062 | sub new { |
1114 | sub new { |
1063 | my ($class, $env, @args) = @_; |
1115 | my ($class, $env, @args) = @_; |
1064 | |
1116 | |
|
|
1117 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1118 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1119 | |
1065 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1120 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1066 | } |
1121 | } |
1067 | |
1122 | |
1068 | =item $term->destroy |
1123 | =item $term->destroy |
1069 | |
1124 | |
1070 | Destroy the terminal object (close the window, free resources |
1125 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1370 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1425 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1371 | to receive pointer events all the times: |
1426 | to receive pointer events all the times: |
1372 | |
1427 | |
1373 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1428 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1374 | |
1429 | |
|
|
1430 | =item $term->focus_in |
|
|
1431 | |
|
|
1432 | =item $term->focus_out |
|
|
1433 | |
|
|
1434 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1435 | |
|
|
1436 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1437 | |
|
|
1438 | Deliver various fake events to to terminal. |
|
|
1439 | |
1375 | =item $window_width = $term->width |
1440 | =item $window_width = $term->width |
1376 | |
1441 | |
1377 | =item $window_height = $term->height |
1442 | =item $window_height = $term->height |
1378 | |
1443 | |
1379 | =item $font_width = $term->fwidth |
1444 | =item $font_width = $term->fwidth |
… | |
… | |
1624 | =item $string = $term->special_decode $text |
1689 | =item $string = $term->special_decode $text |
1625 | |
1690 | |
1626 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1691 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1627 | C<< $term->ROW_t >> for details. |
1692 | C<< $term->ROW_t >> for details. |
1628 | |
1693 | |
1629 | =item $success = $term->grab_button ($button, $modifiermask) |
1694 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1630 | |
1695 | |
|
|
1696 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1697 | |
1631 | Registers a synchronous button grab. See the XGrabButton manpage. |
1698 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1699 | manpage. |
1632 | |
1700 | |
1633 | =item $success = $term->grab ($eventtime[, $sync]) |
1701 | =item $success = $term->grab ($eventtime[, $sync]) |
1634 | |
1702 | |
1635 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1703 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1636 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1704 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1754 | my ($self, $text, $cb) = @_; |
1822 | my ($self, $text, $cb) = @_; |
1755 | |
1823 | |
1756 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1824 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1757 | } |
1825 | } |
1758 | |
1826 | |
1759 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1827 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1760 | |
1828 | |
1761 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1829 | Adds a toggle/checkbox item to the popup. The callback gets called |
1762 | whenever it gets toggled, with a boolean indicating its value as its first |
1830 | whenever it gets toggled, with a boolean indicating its new value as its |
1763 | argument. |
1831 | first argument. |
1764 | |
1832 | |
1765 | =cut |
1833 | =cut |
1766 | |
1834 | |
1767 | sub add_toggle { |
1835 | sub add_toggle { |
1768 | my ($self, $text, $cb, $value) = @_; |
1836 | my ($self, $text, $value, $cb) = @_; |
1769 | |
1837 | |
1770 | my $item; $item = { |
1838 | my $item; $item = { |
1771 | type => "button", |
1839 | type => "button", |
1772 | text => " $text", |
1840 | text => " $text", |
1773 | value => $value, |
1841 | value => $value, |